singa-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From wan...@apache.org
Subject svn commit: r1679950 - in /incubator/singa/site/trunk/content: ./ markdown/ markdown/community/ markdown/develop/
Date Mon, 18 May 2015 07:16:56 GMT
Author: wangsh
Date: Mon May 18 07:16:55 2015
New Revision: 1679950

URL: http://svn.apache.org/r1679950
Log:
add development menu; move some content from community tag to development tag;

Added:
    incubator/singa/site/trunk/content/markdown/develop/
    incubator/singa/site/trunk/content/markdown/develop/contribute-code.md
    incubator/singa/site/trunk/content/markdown/develop/contribute-docs.md
    incubator/singa/site/trunk/content/markdown/develop/how-contribute.md
    incubator/singa/site/trunk/content/markdown/develop/schedule.md
Removed:
    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
    incubator/singa/site/trunk/content/markdown/community/schedule.md
Modified:
    incubator/singa/site/trunk/content/markdown/index.md
    incubator/singa/site/trunk/content/site.xml

Added: incubator/singa/site/trunk/content/markdown/develop/contribute-code.md
URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/content/markdown/develop/contribute-code.md?rev=1679950&view=auto
==============================================================================
--- incubator/singa/site/trunk/content/markdown/develop/contribute-code.md (added)
+++ incubator/singa/site/trunk/content/markdown/develop/contribute-code.md Mon May 18 07:16:55
2015
@@ -0,0 +1,43 @@
+## How to Contribute Code
+
+_____
+
+Like other Apache projects, SINGA uses JIRA to track bugs, improvements and
+other high-level discussions (e.g., system design and features).  Github pull requests are
+used for implementation discussions, e.g., code review and code merge.
+
+### JIRA format
+
+* Provide a descriptive Title.
+* Write a detailed Description. For bug reports, this should ideally include a
+  short reproduction of the problem. For new features, it may include a design
+  document.
+* Set [required fields](https://cwiki.apache.org/confluence/display/SPARK/Contributing+to+Spark#ContributingtoSpark-JIRA)
+
+### Pull Request
+
+The work flow is
+
+* Fork the [SINGA Github repository](https://github.com/apache/incubator-singa) to
+your own Github account.
+
+* Clone your fork, create a new branch (e.g., feature-foo or fixbug-foo),
+ work on it. After finishing your job,
+ [rebase](https://git-scm.com/book/en/v2/Git-Branching-Rebasing) it to the
+ current latest master and push commits to your own Github account (the new
+ branch).
+
+* Open a pull request against the master branch of apache/incubator-singa.
+The PR title should be of the form [SINGA-xxxx] Title, where
+SINGA-xxxx is the relevant JIRA number, and Title may be the JIRA's title or a
+more specific title describing the PR itself. The link to the JIRA should be
+provided. Detailed description can be copied from the JIRA.
+Consider identifying committers or other contributors who have worked on the
+code being changed. Find the file(s) in Github and click "Blame" to see a
+line-by-line annotation of who changed the code last.  You can add @username in
+the PR description to ping them immediately.
+Please state that the contribution is your original work and that you license
+the work to the project under the project's open source license.
+
+* Wait for one committer to review the patch. Further commits (e.g., bug fix)
+to your new branch will be added to this pull request automatically by Github.

Added: incubator/singa/site/trunk/content/markdown/develop/contribute-docs.md
URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/content/markdown/develop/contribute-docs.md?rev=1679950&view=auto
==============================================================================
--- incubator/singa/site/trunk/content/markdown/develop/contribute-docs.md (added)
+++ incubator/singa/site/trunk/content/markdown/develop/contribute-docs.md Mon May 18 07:16:55
2015
@@ -0,0 +1,45 @@
+## 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.
+
+A video tutorial on how to use the CMS is available [here](http://s.apache.org/cms-tutorial).
+
+If you are not a committer and want to edit the content, please see [here](http://www.apache.org/dev/cmsref.html#non-committer).
A video tutorial for anonymous users is available [here](http://s.apache.org/cms-anonymous-tutorial).
+
+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/develop/how-contribute.md
URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/content/markdown/develop/how-contribute.md?rev=1679950&view=auto
==============================================================================
--- incubator/singa/site/trunk/content/markdown/develop/how-contribute.md (added)
+++ incubator/singa/site/trunk/content/markdown/develop/how-contribute.md Mon May 18 07:16:55
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](../community/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](../community/issue-tracking.html)
application.
+* Check SINGA's [development schedule](schedule.html) and [contribute code](contribute-code.html)
by providing patches. 
+* [Help with the documentation](contribute-docs.html) by updating webpages that are lacking
or unclear.

Added: incubator/singa/site/trunk/content/markdown/develop/schedule.md
URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/content/markdown/develop/schedule.md?rev=1679950&view=auto
==============================================================================
--- incubator/singa/site/trunk/content/markdown/develop/schedule.md (added)
+++ incubator/singa/site/trunk/content/markdown/develop/schedule.md Mon May 18 07:16:55 2015
@@ -0,0 +1,42 @@
+Title: Development Schedule
+Notice:    Licensed to the Apache Software Foundation (ASF) under one
+           or more contributor license agreements.  See the NOTICE file
+           distributed with this work for additional information
+           regarding copyright ownership.  The ASF licenses this file
+           to you under the Apache License, Version 2.0 (the
+           "License"); you may not use this file except in compliance
+           with the License.  You may obtain a copy of the License at
+           .
+             http://www.apache.org/licenses/LICENSE-2.0
+           .
+           Unless required by applicable law or agreed to in writing,
+           software distributed under the License is distributed on an
+           "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+           KIND, either express or implied.  See the License for the
+           specific language governing permissions and limitations
+           under the License.
+
+## Development Schedule
+
+| Release | Module| Feature | Status |
+|---------|---------|-------------|--------|
+| 0.1     | Neural Network |1.1. Feed forward neural network, including CNN, MLP | done|
+|         |                |1.2. RBM-like model, including RBM | working|
+|         |                |1.3. Recurrent neural network, including standard RNN | working|
+|         | Architecture   |1.4. One worker group on single node (with data partition)| done|
+|         |                |1.5. Multi worker groups on single node using [Hogwild](http://www.eecs.berkeley.edu/~brecht/papers/hogwildTR.pdf)|working|
+|         |                |1.6. Multi groups across nodes, like [Downpour](http://papers.nips.cc/paper/4687-large-scale-distributed-deep-networks)|working|
+|         | Resource Management |1.7. Integration with Mesos | working|
+|         | Failure recovery|1.8. Checkpoint and restore |working|
+|         | Tools|1.9. Installation with GNU auto tools| done|
+|0.2      | Neural Network |2.1. Feed forward neural network, including auto-encoders, hinge
loss layers, HDFS data layers||
+|         |                |2.2. RBM-like model, including DBM | |
+|         |                |2.3. Recurrent neural network, including LSTM| |
+|         |                |2.4. Model partition ||
+|         | Communication  |2.5. MPI||
+|         | GPU            |2.6. Single GPU ||
+|         |                |2.7. Multiple GPUs on single node||
+|         | Architecture   |2.8. All-Reduce training architecture like [DeepImage](http://arxiv.org/abs/1501.02876)||
+|         | Fault Tolerance|2.9. Node failure detection and recovery||
+|         | Binding        |2.9. Python binding ||
+|         | User Interface |2.10. Web front-end for job submission and performance visualization||

Modified: incubator/singa/site/trunk/content/markdown/index.md
URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/content/markdown/index.md?rev=1679950&r1=1679949&r2=1679950&view=diff
==============================================================================
--- incubator/singa/site/trunk/content/markdown/index.md (original)
+++ incubator/singa/site/trunk/content/markdown/index.md Mon May 18 07:16:55 2015
@@ -16,7 +16,7 @@ guide to download, install and run SINGA
 * If you find any issues using SINGA, please report it to the
 [Issue Tracker](community/issue-tracking.html).
 
-More details on contributing to SINGA is describe [here](community.html).
+More details on contributing to SINGA is describe [here](develop/how-contribute.html).
 
 ### License
 SINGA is released under [Apache License Version 2.0](http://www.apache.org/licenses/LICENSE-2.0).

Modified: incubator/singa/site/trunk/content/site.xml
URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/content/site.xml?rev=1679950&r1=1679949&r2=1679950&view=diff
==============================================================================
--- incubator/singa/site/trunk/content/site.xml (original)
+++ incubator/singa/site/trunk/content/site.xml Mon May 18 07:16:55 2015
@@ -64,11 +64,15 @@
       <item name="Programming Model" href="docs/programming-model.html"/>
     </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"/>
+    <menu name="Development">
+      <item name="Schedule" href="develop/schedule.html"/>
+      <item name="How to Contribute" href="develop/how-contribute.html">
+        <item name="Code" href="develop/contribute-code.html"/>
+        <item name="Documentation" href="develop/contribute-docs.html"/>
       </item>
+    </menu>
+
+    <menu name="Community">
       <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