Update docs; How to write or update docs
Project: http://git-wip-us.apache.org/repos/asf/incubator-usergrid/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-usergrid/commit/fa23ab7d Tree: http://git-wip-us.apache.org/repos/asf/incubator-usergrid/tree/fa23ab7d Diff: http://git-wip-us.apache.org/repos/asf/incubator-usergrid/diff/fa23ab7d Branch: refs/heads/master Commit: fa23ab7dcea352d157074534f528aa494a7bfb89 Parents: 2d073b5 Author: Sungju Jin <[email protected]> Authored: Thu Oct 23 03:23:44 2014 +0900 Committer: Sungju Jin <[email protected]> Committed: Thu Oct 23 03:23:44 2014 +0900 ---------------------------------------------------------------------- docs/README | 31 +++++++++++++++++++++++++++++++ docs/contribute-code.md | 10 ++++++---- 2 files changed, 37 insertions(+), 4 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/fa23ab7d/docs/README ---------------------------------------------------------------------- diff --git a/docs/README b/docs/README new file mode 100644 index 0000000..e4bb4ac --- /dev/null +++ b/docs/README @@ -0,0 +1,31 @@ +# Apache Usergrid Docs + +We use Sphinx for documentions. + +## Pre requirements + +* sphinx +* pip + + $ sudo easy_install sphinx + $ sudo easy_install pip + +## How to gererate docs + + cd $usergrid/docs + make clean html + +## How to update documentations in Usergrid site + +Note that this update is only available for Usergrid PPMC and committers. + + $ svn --username "APACHE_USERNAME" --password "APACHE_PASSWORD" co https://svn.apache.org/repos/asf/incubator/usergrid/site/ + +If you added any files: + $ svn add <file or directory> + +Then commit: + $ svn ci -m "Some message" + +To pull down the latest: + $ svn update \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/fa23ab7d/docs/contribute-code.md ---------------------------------------------------------------------- diff --git a/docs/contribute-code.md b/docs/contribute-code.md index 7c9e600..f63c6e8 100644 --- a/docs/contribute-code.md +++ b/docs/contribute-code.md @@ -4,14 +4,14 @@ Code Contributions --- The Usergrid project has adopted a policy for how code is to be contributed by external contributors, and by those who are committers on the project. -You can read this policy here [Usergrid Contribution Workflow](https://cwiki.apache.org/confluence/display/apache/incubator-usergrid+Contribution+Workflow). +You can read this policy here [Usergrid Contribution Workflow](https://cwiki.apache.org/confluence/display/usergrid/Usergrid+Contribution+Workflow). Basically, we use GitHub as our code review system. So you should fork the apache/incubator-usergrid repo and submit PRs back to the project. Here are are step-by-step guide for both both external contributors and committers: -* [External Contributors Guide](https://cwiki.apache.org/confluence/display/apache/incubator-usergrid+External+Contributors+Guide) -* [Usergrid Committers Guide](https://cwiki.apache.org/confluence/display/apache/incubator-usergrid+Committers+Guide) +* [External Contributors Guide](https://cwiki.apache.org/confluence/display/usergrid/Usergrid+External+Contributors+Guide) +* [Usergrid Committers Guide](https://cwiki.apache.org/confluence/display/usergrid/Usergrid+Committers+Guide) Website and Documentation Contributions --- @@ -19,4 +19,6 @@ If you want to contribute to the documentation you'll find that we use a differe system. Our website and documentation is managed in Subversion. Here's a README file that explains how to get the website and documentation source code and make changes: -* [README.md for website and documentation](http://svn.apache.org/viewvc/incubator/usergrid/site/README.md?view=markup) +* [README.md for website](http://svn.apache.org/viewvc/incubator/usergrid/site/README.md?view=markup) + +* [README.md for documentation](https://github.com/apache/incubator-usergrid/tree/master/docs) \ No newline at end of file
