Sugar Labs

Sugar on a Stick/Documentation SOP: Difference between revisions

← Older edit
Mchua (talk | contribs)
779 edits
mNo edit summary
 
(7 intermediate revisions by 2 users not shown)
Line 5: Line 5:
You can view a reasonably up-to-date version of the files here:
You can view a reasonably up-to-date version of the files here:


* [http://people.sugarlabs.org/sdz/customization-guide/ Customization Guide]
* [http://mirrors.rit.edu/sugarlabs/soas/docs/customization-guide/index.html Customization Guide]
* [http://people.sugarlabs.org/sdz/creation-kit/ Creation Kit]
* [http://mirrors.rit.edu/sugarlabs/soas/docs/creation-kit/index.html Creation Kit]


This is not a permanent location (the URLs above will likely be moving between now and May 2010), and these files may not be completely up-to-date; we are currently obtaining a more permanent infrastructure solution, but the links should suffice at present.
This is not a permanent location (the URLs above will likely be moving between now and May 2010), and these files may not be completely up-to-date; we are currently obtaining a more permanent infrastructure solution, but the links should suffice at present.
Line 14: Line 14:
=== Checking out the latest Version ===
=== Checking out the latest Version ===


Clone the GIT repository with the Sugar on a Stick documentation from GIT by running:
Clone the [http://git.sugarlabs.org/soas-docs 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>
<pre>git clone git://git.sugarlabs.org/soas-docs/mainline.git soas-docs</pre>


Line 20: Line 20:


* Edit away! - Try to follow these conventions [https://fedorahosted.org/publican/browser/trunk/publican/datadir/Common_Content/common/en-US/Conventions.xml here].
* Edit away! - Try to follow these conventions [https://fedorahosted.org/publican/browser/trunk/publican/datadir/Common_Content/common/en-US/Conventions.xml here].
**For example, Move down to a directory you want to edit, and edit a file with gedit
<pre>cd soas-docs
ls
cd Creation\ Kit/
cd en-US
ls
gedit Book_Info.xml</pre>
* Bump the edition tag in ''Book_Info.xml'' after a major change.
* Bump the edition tag in ''Book_Info.xml'' after a major change.
* Make sure to explain your change in Revision_History.xml
* Make sure to explain your change in Revision_History.xml
Line 25: Line 34:
=== Generating HTML or PDF output ===
=== Generating HTML or PDF output ===


Install publican if you haven't already. On most Linux distributions, this will be:
Install publican if you haven't already. If you are running a yum-based system (Fedora, SuSE, etc), this is:


  sudo yum install publican
  sudo yum install publican
If you are running an apt-based system (Debian, Ubuntu, etc), this is:
sudo apt-get install publican


In the same directory as the file '''''publican.cfg''''' (this will almost certainly be '''''/path/to/soas-docs/Customization Guide''''' or '''''/path/to/soas-docs/Creation Kit'''''), run the following command.
In the same directory as the file '''''publican.cfg''''' (this will almost certainly be '''''/path/to/soas-docs/Customization Guide''''' or '''''/path/to/soas-docs/Creation Kit'''''), run the following command.
Line 77: Line 90:
==== If you have commit access ====
==== If you have commit access ====


Once you have edited the files you want to commit, make the commit.
If you need to apply someone else's patch to the file before committing it, do that first.
 
patch -p0 < path/file.patch
 
Once you have applied the patch and otherwise edited the files you want to commit, make the commit.


  git commit -a
  git commit -a
Retrieved from "https://wiki.sugarlabs.org/go/Sugar_on_a_Stick/Documentation_SOP"