This documentation shows how to edit the Apache ODF Toolkit website. This includes creation of new pages, modification, and deletion - for files and sub-directories.
The website is hosted in a Content Management System (CMS). When you edit a web page there are potentially four different versions of it to think about:
The general flow for updating the website is:
The intent of this workflow is to allow committers flexibility in changing webpages and testing changes on a staging website, before moving these changes to the public web site.
It is assumed that you have already checked out the code from the SVN repository (https://svn.apache.org/repos/asf/incubator/odf).
Edit the file via your favorite editor like vi and finally commit via SVN:
vi myfile.mdtext svn ci -m"My log message" myfile.mdtext
Now wait a few seconds so that the entire website can be rebuilt. Verify the staged webpage in a web browser at:
Then publish the site:
curl -sL http://s.apache.org/cms-cli | perl
If this does not work on your local machine just do it on "people.apache.org" by executing this:
ssh -t <user>@people.apache.org publish.pl odftoolkit <your Apache ID>
Furthermore, you need an Apache ID to authenticate to the system.
Browse to the webpage or directory you would like to edit and click on the bookmarklet. Now click on the [Edit this directory] link on the top. The following is displayed as content from the CMS.
Click on the actions link [Edit] in the appropriate table cell for editing the current file. If the file is not in this directory but in a subdirectory, just click on the directory name (e.g., "docs/") to enter this directory.
Now you should see a new webpage with four fields:
When you have finished writing your text, check the "Quick Commit" box, enter a commit message and click on [Submit]. This commits your changes to the Subversion repository.
As noted above, committing your changes triggers a build of the markdown files into HTML in the staging directory. Wait a few seconds and then click the [Staged] link to view your web page as staged.
At this point you should test your web page. Does it look right? Any spelling errors? Do the links work? If you've made substantial changes, perhaps test in more than one browser.
Once you are satisfied that the page is correct, you are ready to publish it to the production site.
After you have edited your files and/or directories, you need now to publish your
modifications into production. For this please click on the link
[Publish site] on the top of the webpage. Enter a commit message on click
on [Submit]. After a few seconds you can check the [Production] link to see the
live version of your changes.
When in the correct directory, at the top enter a name for the new text file (e.g., "my-file.mdtext"). Now you enter your text (see topic above).
When in the correct directory, at the top enter a name for the new directory (e.g., "my-dir/"). Make sure you entered a trailing "/"!
When in the correct directory, click on the actions link [Delete] in the appropriate table cell and enter a commit message. Finally click on [Submit]. Generally speaking it is always a good idea to use the CMS to delete files and directories over using the command-line svn interface, as the CMS will ensure everything gets deleted from the staging (and eventually production) repository on commit. If you use the command- line interface instead, you will also need to manually delete the corresponding entities in the staging repository in order for those changes to propagate to the production site.