Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The site is distributed across two systems. The first is a Subversion based system that is used for the "top level" site. The second are wiki pages that are linked from that top level site.

Top Level Site

The top level site is kept under Subversion control. Committing the files causes the top level website to be updated.

1. Checkout site files

...

Code Block
svn checkout https://svn.apache.org/repos/asf/incubator/knox knox-site
cd knox-site

2. Update

...

site files

If you are reusing an existing site source directory you will need to update the files to ensure that you have the latest from the remote Subversion repository.

...

Note

The static site files only need to be regenerated if you want the published site to be updated. If you are updating the content of a book for an upcoming release you might not want to do that. In this case you can just skip to "Commit site files" to commit those changes without publishing them.

Code Block

ant generate

If you are only modifying the books or the top level website you can use on of these commands respectivly.

Code Block
ant -f trunk/build.xml books
ant -f trunk/build.xml site 

5. Review generated static site and book

If you generated the static site and book files above you can review them in the default browser using the two convenience ant targets shows below.

Code Block
ant -f trunk/build.xml review-site
ant -f trunk/build.xml review-book

6. Create a patch

If you do not have commit privileges so the site repository you will need to create a patch an upload that to a Jira. From the root of the site repository the patch can be created with the following command. This is the directory that contains the sub-directories: branches, site, tags, trunk.

...