THIS IS A TEST INSTANCE. ALL YOUR CHANGES WILL BE LOST!!!!
...
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.
...
The first time you work with the site you will need to check it out from Subversion. The knox-site directory can be any directory you prefer. You can skip the "Update local site files" step the first time you checkout the files.
| Code Block |
|---|
svn checkout https://svn.apache.org/repos/asf/incubator/knox knox-site cd knox-site |
...
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.
| Code Block |
|---|
cd knox-site
svn update
|
3. Modify site files
...
| 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
|
...
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 review
|
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. First revert any changes to the site directory as these will be regenerated by the committer. Including these in the patch will make the patch review much more difficult.
| Code Block |
|---|
svn revert --recursive site
svn diff > KNOX-nnn.patch
|
...
If you are committing a change on a contributors behalf you will need to download the patch from the Jira and apply it using the following command. This is the directory that contains the sub-directories: branches, site, tags, trunk.
| Code Block |
|---|
patch -p0 -i KNOX-nnn.patch
|
...
The committing of the files causes the site to be published. In particular the generated static files in site are published to the Apache website. The following command should be run in the root of the site directory structure. This is the directory that contains the sub-directories: branches, site, tags, trunk.
| Code Block |
|---|
svn commit -m "Update of site."
|
...
Wiki pages for the site should be created in this wiki space.
IMPORTANT: These wiki pages must not be linked to directly. This can cause performance problems and is strongly discouraged in the Apache documentation. Links should instead be made to static HTML copies that are automatically created each time a wiki is updated. This page for example is linked from the top level site using this URL https://cwiki.apache.org/KNOX/site-maintenance.html.
| Include Page |
|---|
...
|
...
|