Edgewall Software

Changes between Version 2 and Version 3 of Bitten Dev/Dev Docs


Ignore:
Timestamp:
May 8, 2010, 12:15:42 AM (14 years ago)
Author:
osimons
Comment:

Various minor tweaks to content.

Legend:

Unmodified
Added
Removed
Modified
  • Bitten Dev/Dev Docs

    v2 v3  
    11= Help Writing Bitten Documentation =
    22
    3 Bitten distribution is accompanied by nice User Manual. You may see a poor reflection of it on [wiki:Documentation/index.html] pages. If you reading this then you already know that these pages are immutable, at least it is not possible to edit them from Wiki. It is because Trac is reading them directly from SVN using Include macros. Typical User Manual page source looks like this:
     3Bitten distribution is accompanied by nice User Manual. You may see a plain reflection of it on [wiki:Documentation/index.html] pages. If you reading this then you already know that these pages are immutable, at least it is not possible to edit them from Wiki. It is because Trac is reading them directly from SVN repository using an `[[Include()]]` macro. Typical User Manual page source looks like this:
    44{{{
    55[[Title(Installation)]]
     
    1010}}}
    1111
    12 These wiki pages were created manually and set to be read only by cmlenz some years ago.
     12These wiki pages are created manually and set to read-only, updatable only by Bitten developers.
    1313
    14 If you need to propose a change - you should be able to checkout docs from SVN, edit sources in reStructuredText format (similar to Wiki), rebuild them to see the result of your changes and send a patch to Bitten MailingList (or attach to a [/newticket new ticket]). This is all this pages are about.
     14If you need to propose a change - you should be able to checkout docs from SVN, edit sources in reStructuredText format (similar to Wiki), rebuild them to see the result of your changes and attach the patch to a [/newticket new ticket] (or open a discussion on Bitten MailingList).
    1515
    1616=== Checkout ===
    1717
    18 Just checkout Bitten. [source:trunk trunk/] or any of [source:tags tags/]/[source:branches/] versions will be ok. For example:
     18Just checkout Bitten. Usually [source:trunk trunk/], but any recent [source:tags tags/] or [source:branches/] is usually also fine. For example:
    1919{{{
    2020svn checkout http://svn.edgewall.org/repos/bitten/trunk bitten-trunk
    2121}}}
    22 will download sources into ''bitten-trunk'' directory.
     22will download sources into a ''bitten-trunk'' directory.
    2323
    2424=== Building Docs ===
     
    3636Just edit *.txt files, which are in [http://docutils.sourceforge.net/rst.html reStructuredText] format and rerun `python setup.py build_doc` to get the edits into html. If you are ready, make a patch file:
    3737{{{
    38 svn diff > documentation.patch.txt
     38svn diff > documentation.diff
    3939}}}
    4040