commit | 0bdace8db5c8b7a76aa8fe6bf421053559e8b21e | [log] [tgz] |
---|---|---|
author | Steve Lawrence <slawrence@apache.org> | Fri Sep 03 14:47:18 2021 -0400 |
committer | Steve Lawrence <stephen.d.lawrence@gmail.com> | Fri Sep 03 17:08:55 2021 -0400 |
tree | 3610bad1d0a103773f37c16e0b8af9808dad1611 | |
parent | 6a0f94c2f185a6840740f21b8b3dc762a8a40d3e [diff] |
Use a generic name/email for website publish commit author When committing website content in the Github publish workflow, we use the github.event.head_commit.committer.name/email values, which should be the name/email of the committer of the change. But sometimes it uses the name/email associated with the account who merged the account (I think), which is not necessarily the correct information. In my case, its uses a personal email instead of an @apache.org email. Since this doesn't information doesn't really matter, and since it's an automated commit, switch to using dev@daffodil.apache.org and a generic Daffodil name when committing changes to the asf-site branch.
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 main branch on GitHub, a GitHub action will automatically be triggered and it will perform the necessary steps to publish the site.