258
edits
Changes
Jump to navigation
Jump to search
Sugar on a Stick/Documentation SOP (view source)
Revision as of 13:28, 28 March 2010
, 13:28, 28 March 2010initial import
Starting with the upcoming SoaS version (release date: ''2010-05-11''), a good amount of the related documentation will be created through [https://fedorahosted.org/publican/ publican]. This [http://en.wikipedia.org/wiki/Standard_operating_procedure SOP] describes how to contribute changes to the documentation.
== Contributing Content to the Documentation ==
=== Checking out the latest Version ===
Clone the GIT repository with the Sugar on a Stick documentation from GIT by running:
<pre>git clone git://git.sugarlabs.org/soas-docs/mainline.git soas-docs</pre>
=== Apply your Changes ===
* Edit away! - Try to follow these conventions [https://fedorahosted.org/publican/browser/trunk/publican/datadir/Common_Content/common/en-US/Conventions.xml here].
* Bump the edition tag in ''Book_Info.xml'' after a major change.
* Make sure to explain your change in Revision_History.xml
=== Create a Patch from your Changes ===
Create a patch using the following command: <pre>git diff > product-name-change.patch</pre>
* ''product'' reflects the folder you made your change in, so either ''creation-kit'' or ''customization-guide''
* ''name'' references to your personal name to track contributions
* ''change'' should be a one or two word description of your proposed change
=== Notify us of your proposed Change ===
Send an email (with a subject line like this ''[PATCH] name-of-your-patch'') to the SoaS [http://lists.sugarlabs.org/listinfo/soas mailing list] together with your patch and an explanation of what you changed and why you think the change is necessary. Discussion will happen on list.
After that, your patch will be committed and pushed. At some point, you might also be granted access to the GIT repository so that you can commit changes directly without submitting the patches to the list.
== Contributing Content to the Documentation ==
=== Checking out the latest Version ===
Clone the GIT repository with the Sugar on a Stick documentation from GIT by running:
<pre>git clone git://git.sugarlabs.org/soas-docs/mainline.git soas-docs</pre>
=== Apply your Changes ===
* Edit away! - Try to follow these conventions [https://fedorahosted.org/publican/browser/trunk/publican/datadir/Common_Content/common/en-US/Conventions.xml here].
* Bump the edition tag in ''Book_Info.xml'' after a major change.
* Make sure to explain your change in Revision_History.xml
=== Create a Patch from your Changes ===
Create a patch using the following command: <pre>git diff > product-name-change.patch</pre>
* ''product'' reflects the folder you made your change in, so either ''creation-kit'' or ''customization-guide''
* ''name'' references to your personal name to track contributions
* ''change'' should be a one or two word description of your proposed change
=== Notify us of your proposed Change ===
Send an email (with a subject line like this ''[PATCH] name-of-your-patch'') to the SoaS [http://lists.sugarlabs.org/listinfo/soas mailing list] together with your patch and an explanation of what you changed and why you think the change is necessary. Discussion will happen on list.
After that, your patch will be committed and pushed. At some point, you might also be granted access to the GIT repository so that you can commit changes directly without submitting the patches to the list.