...
- The directory
trunk/src/site/markdown
contains Markdown files for the site. - The directory
trunk/src/site/resources
contains the status resources (e.g. images, etc) for the site. - The directory
trunk/books
contains the source for various books.
4. Optionally 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 resulting static files will be generated into site
. You can open the file site/index.html in your browser to review your changes before publishing.
...
Code Block |
---|
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.
Code Block |
---|
svn diff > KNOX-nnn.patch |
...
7. Review site changes
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 |
...
8. 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. 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." |
...
9. 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.
...