commit | d763325bd4df574350dc81fef78851e104771037 | [log] [tgz] |
---|---|---|
author | Mike Beckerle <mbeckerle@tresys.com> | Tue Jan 21 10:33:06 2020 -0500 |
committer | GitHub <noreply@github.com> | Tue Jan 21 10:33:06 2020 -0500 |
tree | 2c25fd14033d3bdcf104300d13a1b285d14bc5ba | |
parent | 1e3d548458ec97a37f35bcc2dde187cb6e299ac8 [diff] |
Design Note for Daffodil-2192 fix - redesign of nextElementResolver for unparser (#12) * Updated draft DFDL Spec with warning banner. * Add dev subdir, and asciidoc design note. Substantial update to design note reflecting code prototyping. * Improve design note. Changed title and reorganized content to be about as-is-built status rather than transition from prior design. Tweaks to asciidoc and aboutAsciidoc page to not have artifacts of jekyll when used via file: URLs directly from browser.
The Apache Daffodil (incubating) web site is based off of the Apache Website Template.
The website is generated using Jekyll and some plug-ins for it.
Some Linux distributions provide Jekyll via their package managers, for example, for Fedora 25
$ dnf install rubygem-jekyll
Alternatively, Jekyll can be installed using gem:
$ gem install jekyll
Some content is developed using the AsciiDoc Markdown variant, which supports embedded diagrams created from diagram-specifying text formats.
(You probably want to install these as super-user using sudo.)
$ gem install jekyll-asciidoc $ gem install asciidoctor-diagram $ apt install python-pip $ pip install blockdiag $ pip install seqdiag $ pip install actdiag $ pip install nwdiag
NOTE: nwdiag
actually supports more than one diagram type. It supports nwdiag, packetdiag, rackdiag, etc.
Before opening a pull request, you can preview your contributions by running from within the directory:
$ jekyll serve --watch --source site
Open http://localhost:4000 to view the site served by Jekyll.
Once satisfied, create a branch and open a pull request using the Daffodil project Code Conttributor Workflow but using the website repo instead of the code repo.
Daffodil uses gitpubsub for publishing to the website. The static content served via apache must be served in the content
directory on the asf-site
orphan branch. Use the publish.sh
script script exists to create this content:
$ ./publish.sh $ git push asf asf-site