Site Maintenance
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
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 site files" step the first time you checkout the files.
svn checkout https://svn.apache.org/repos/asf/incubator/knox knox-site cd knox-site
2. Refresh 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.
cd knox-site svn update
3. Modify site files
Most of the files are in Markdown format in trunk/src/site/markdown
but there are a few important files in trunk/src/site
that control the overall site and resources such as images are in trunk/src/site/resources
.
4. Generate static site files
Once you have finished making changes the files must be committed in order to publish them to the Apache site. These files will be generated into site
. The touch
command shown below is to ensure that the site/index.html file is generated even if the index.md
file isn't modified.
touch trunk/src/site/markdown/index.md mvn -f trunk/pom.xml site
5. Commit site files
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.
svn commit -m "Update of site."
6. Validate site
The site typically takes less than 5 minutes to update. You should confirm however that your changes have properly been published to the public site.
Wiki Pages
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.