8,288
edits
Changes
Jump to navigation
Jump to search
mLine 14:
Line 14: − + Line 20:
Line 20: + + + + + + + + + Line 25:
Line 34: − + + + + +
Sugar on a Stick/Documentation SOP (view source)
Revision as of 15:34, 22 December 2010
, 15:34, 22 December 2010no edit summary
=== 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>
* 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
=== 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.