commit | ed8a08ca591896c4bfe3c978b083993736215729 | [log] [tgz] |
---|---|---|
author | Michael Beckerle <mbeckerle@tresys.com> | Tue Jan 21 16:07:39 2020 -0500 |
committer | Mike Beckerle <mbeckerle@tresys.com> | Mon Feb 10 18:22:08 2020 -0500 |
tree | c55954a87df066e191fce8619200a99b78257b00 | |
parent | 61d109b7c81ae60dd038b7555fbde5e31bf9967f [diff] |
New asciidoc design notes on schema compiler space/speed issue. There are 3 new notes: * term-sharing-in-the-schema-compiler.adoc * hidden-groups.adoc * namespace-binding-minimization.adoc They can be read on the Daffodil web site, or you can check-out the daffodil-site repository and view them directly. There is a PR for review comments on these asciidoc texts. https://github.com/apache/incubator-daffodil-site/pull/17 These go along with a wiki document: https://cwiki.apache.org/confluence/display/DAFFODIL/Analysis%3A+Schema+Compiler+Backpointers+and+Copying Changes to the aboutAsciidoc.adoc file are just about the approach of using asciidoc for this sort of design note. Based on some preliminary reviews, added transition sections for isHidden and namespace bindings notes. DAFFODIL-1444
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 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
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.