How to Contribute Documentation
This document gives step-by-step instructions for deploying Singa website.
Singa website is managed by Apache CMS.
Singa website is built by Maven from a source tree stored in svn: https://svn.apache.org/repos/asf/incubator/singa/site/trunk.
Edit Source Content
You can edit source content in 2 ways:
- Use the CMS UI through your web browser:
- Go to https://cms.apache.org/singa/ and install the bookmarklet.
- Go to the webpage you want to modify.
- Click the installed ASF CMS bookmarklet which enable you to browse the content in CMS.
- Navigate to the content you want to modify and click the button “Edit”.
- Once you have modified the content, commit with the button “Submit”.
- Checkout with svn and work locally:
- Checkout the source content: svn co https://svn.apache.org/repos/asf/incubator/singa/site/trunk.
- Modify the content with your favorite text editor.
- Test website in local: mvn site.
- Check-in source modifications.
A video tutorial on how to use the CMS is available here.
If you are not a committer and want to edit the content, please see here. A video tutorial for anonymous users is available here.
After source tree is modified in svn, a Buildbot job is triggered:
- It builds the HTML site using maven-site-plugin: mvn site.
- It publishes generated HTML content to CMS staging svn area.
- Svnpubsub mechanism transfers svn CMS staging content to live CMS staging site: http://singa.staging.apache.org.