singa-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From wan...@apache.org
Subject svn commit: r1679498 - in /incubator/singa/site/trunk/content: markdown/community/contribute-code.md markdown/community/contribute-docs.md markdown/community/how-contribute.md markdown/community/issue-tracking.md site.xml
Date Fri, 15 May 2015 06:12:00 GMT
Author: wangsh
Date: Fri May 15 06:11:59 2015
New Revision: 1679498

URL: http://svn.apache.org/r1679498
Log:
add guide to edit website using CMS

Added:
    incubator/singa/site/trunk/content/markdown/community/contribute-code.md
    incubator/singa/site/trunk/content/markdown/community/contribute-docs.md
    incubator/singa/site/trunk/content/markdown/community/how-contribute.md
Modified:
    incubator/singa/site/trunk/content/markdown/community/issue-tracking.md
    incubator/singa/site/trunk/content/site.xml

Added: incubator/singa/site/trunk/content/markdown/community/contribute-code.md
URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/content/markdown/community/contribute-code.md?rev=1679498&view=auto
==============================================================================
    (empty)

Added: incubator/singa/site/trunk/content/markdown/community/contribute-docs.md
URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/content/markdown/community/contribute-docs.md?rev=1679498&view=auto
==============================================================================
--- incubator/singa/site/trunk/content/markdown/community/contribute-docs.md (added)
+++ incubator/singa/site/trunk/content/markdown/community/contribute-docs.md Fri May 15 06:11:59
2015
@@ -0,0 +1,43 @@
+## How to Contribute Documentation
+
+___
+
+This document gives step-by-step instructions for deploying [Singa website](http://singa.incubator.apache.org).
+
+Singa website is managed by [Apache CMS](http://www.apache.org/dev/cms.html).
+
+Singa website is built by [Maven](https://maven.apache.org) 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:
+
+1. 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".
+2. 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.
+
+If you are not a committer and want to edit the content, please see [here](http://www.apache.org/dev/cmsref.html#non-committer).
+
+After source tree is modified in svn, a Buildbot job is triggered:
+
+1. It builds the HTML site using maven-site-plugin: `mvn site`.
+2. It publishes generated HTML content to CMS [staging svn area](https://svn.apache.org/repos/infra/websites/staging/singa/trunk/content/).
+3. Svnpubsub mechanism transfers svn CMS staging content to live CMS staging site: http://singa.staging.apache.org.
+
+
+### Publish site content
+
+If everything is good, publish modifications using [CMS publish](https://cms.apache.org/singa/publish)
action.
+
+Under the hood:
+
+1. CMS copies CMS staging svn area content to [website production svn area](https://svn.apache.org/repos/infra/websites/production/singa/content/).
+2. Svnpubsub mechanism transfers svn production content to live production site: http://singa.incubator.apache.org.

Added: incubator/singa/site/trunk/content/markdown/community/how-contribute.md
URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/content/markdown/community/how-contribute.md?rev=1679498&view=auto
==============================================================================
--- incubator/singa/site/trunk/content/markdown/community/how-contribute.md (added)
+++ incubator/singa/site/trunk/content/markdown/community/how-contribute.md Fri May 15 06:11:59
2015
@@ -0,0 +1,11 @@
+## How to Contribute to SINGA
+
+___
+
+As with any open source project, there are several ways you can help:
+
+* Join the [mailing list](mail-lists.html) and answer other user's questions.
+* [Build Singa](../quick-start.html) for yourself, in order to fix bugs.
+* Report bugs, feature requests and other issues in the [issue tracking](issue-tracking.html)
application.
+* [Help with the code](contribute-code.html) by providing patches.
+* [Help with the documentation](contribute-docs.html) by updating webpages that are lacking
or unclear.

Modified: incubator/singa/site/trunk/content/markdown/community/issue-tracking.md
URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/content/markdown/community/issue-tracking.md?rev=1679498&r1=1679497&r2=1679498&view=diff
==============================================================================
--- incubator/singa/site/trunk/content/markdown/community/issue-tracking.md (original)
+++ incubator/singa/site/trunk/content/markdown/community/issue-tracking.md Fri May 15 06:11:59
2015
@@ -6,4 +6,4 @@ The Singa project uses [JIRA](https://ww
 
 Issues, bugs, and feature requests should be submitted to the following issue tracking system
for this project.
 
-* [https://issues.apache.org/jira/browse/singa](https://issues.apache.org/jira/browse/singa)
+* https://issues.apache.org/jira/browse/singa

Modified: incubator/singa/site/trunk/content/site.xml
URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/content/site.xml?rev=1679498&r1=1679497&r2=1679498&view=diff
==============================================================================
--- incubator/singa/site/trunk/content/site.xml (original)
+++ incubator/singa/site/trunk/content/site.xml Fri May 15 06:11:59 2015
@@ -65,6 +65,10 @@
     </menu>
 
     <menu name="Community">
+      <item name="How to Contribute" href="community/how-contribute.html">
+        <item name="Code" href="community/contribute-code.html"/>
+        <item name="Documentation" href="community/contribute-docs.html"/>
+      </item>
       <item name="Source Repository" href="community/source-repository.html"/>
       <item name="Mailing Lists" href="community/mail-lists.html"/>
       <item name="Issue Tracking" href="community/issue-tracking.html"/>



Mime
View raw message