Updated draft DFDL Spec with warning banner. (#15)

tree: 2c25fd14033d3bdcf104300d13a1b285d14bc5ba
  1. site/
  2. .gitignore
  3. .project
  4. DISCLAIMER
  5. LICENSE
  6. NOTICE
  7. publish.sh
  8. README.md
README.md

Apache Daffodil (incubating) Website

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.

How to deploy this web site

Install Jekyll

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

Install Jekyll Plug-ins for AsciiDoc and Diagram Rendering

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.

Running locally

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.

Pushing to the live site

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