| commit | 8e9fb6a1faa804d992b2c543fce3c09c293c48d5 | [log] [tgz] |
|---|---|---|
| author | John Interrante <interran@research.ge.com> | Sun May 09 15:05:13 2021 -0400 |
| committer | Steve Lawrence <stephen.d.lawrence@gmail.com> | Wed May 19 07:58:56 2021 -0400 |
| tree | 16c427bfc0ce104aca897823ddd5db9920a009bc | |
| parent | a5c5ed0727576adb6d8cf1aceceb4f0009049b6a [diff] |
Update CLI documentation for Daffodil 3.1.0
Fix or disable markdownlint warnings.
Convert list of subcommands to bullets.
Document new "generate" subcommand.
Add CC environment variable, clarifying "test" subcommand will use CC
environment variable if testing runtime2. Also mention Daffodil will
pick first driver command it finds within PATH from a list if CC
environment variable is not defined.
Compare CLI documentation with Daffodil's in-program CLI help
information and make them match each other better, such as sorting
essential usage options first and then rest of options alphabetically.
Proofread CLI documentation and reword some phrases to improve
readability and consistency.
Remove confusing [{<namespace>}] from -D and -r options.
Remove -p, --path option since Daffodil allows only "/".
Add validator plugin name to validation modes and clarify validation
mode is not optional anymore. Remove validation option from
save-parser since it doesn't support that option.
Rename testname to testnames for consistency.
Add "Defaults to" in more places.
DAFFODIL-817, DAFFODIL-2477
The Apache Daffodil website is based off of the Apache Website Template.
The website is generated using Jekyll and some plug-ins for it.
Some Linux distributions provide the Ruby Bundler via their package managers, for example, for Fedora:
$ dnf install rubygem-bundler
$ gem install
or
$ gem update
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.)
$ 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
If that fails to work due to missing jekyll plugin versions, try:
$ bundle exec 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. When the changes are merged into the master branch on GitHub, a GitHub action will automatically be triggered and it will perform the necessary steps to publish the site.