From Fedora Project Wiki

No edit summary
Line 1: Line 1:
{{needs love}}
1. Apply to have your document hosted on fedorahosted.org
== Writing Documentation ==


* [[Docs/WritingDraftDocs|  Writing Draft Documents]]
File a ticket to request hosting from the Fedora Infrastructure team: https://hosted.fedoraproject.org/fedora-infrastructure/newticket
* [[Docs/Writing_Using_The_Wiki|  Writing Using The Wiki]]
* [[Docs/FixingBugs|  Fixing Bugs]]
* [[Docs/Beats/HowTo|  Writing Beats How-To]]


=== The Tools of Fedora Documentation ===
You can find instructions for filling out the ticket here: https://fedorahosted.org/web/new


* [[Docs/UsingGpg|  Using GPG]]
Note also:


'''Drafts'''
    * Git is the preferred SCM for Fedora Documentation
    * By convention, documentation Git repos are prefaced with docs/, so request docs/Your_Guide.git as the Project Name in the ticket.
    * It's a good idea to recommend a Trac instance so that you can publish some basic details of your project. For example: https://fedorahosted.org/install-guide/


* [[Docs/CvsUsage|  CVS Usage]]
2. Add your guide to the Docs Project guides table
* [[Docs/CvsHelp|  CVS Help]]
 
When you have some hosting space and have checked in your source code, add your details and details of your guide to the guides table in the Fedora wiki: https://fedoraproject.org/wiki/Docs_Project_guides_table#Guides
 
3. Add your guide to Transifex
 
Transifex is the Fedora Project's translation interface.
 
If you have a stable version of your guide, create a separate branch in which translators can work. This branch is named after the branch of Fedora for which the documentation is to be released. The master branch of your document is used only for developing the English text and should not contain POT or PO files. The process for branching a Fedora document for translation is outlined on the Fedora wiki: https://fedoraproject.org/wiki/Branching_a_document_in_git
 
The translation branch should contain the Publican pot directory and any language directories that you are importing. You should also run publican update_po to add a few other languages heavily translated in Fedora, including nl-NL (Dutch), pl-PL (Polish), pt-PT (Portuguese), sv-SE (Swedish), and uk-UA (Ukrainian).
 
When you have created the translation branch, follow the instructions on the Fedora wiki to request the Fedora Localization Team to add it to Transifex: https://fedoraproject.org/wiki/L10N/FAQ#How_do_I_add_a_module_to_Transifex.3F_.28.23add-transifex.29
 
If your guide is still under development, you do not need to create a branch for translations yet. Wait until you finalise the English content first.
 
4. Publish your guide on docs.fedoraproject.org
 
Check out the git repo that holds the content of the docs.fedoraproject.org website:
 
<pre>ssh://USERNAME@git.fedorahosted.org/git/docs/web.git</pre>
 
Build your book in Publican, then insert it into a logical place in the directory structure. Edit the top-level index.html file to link to your book in the formats and languages in which it is available.
 
This process is currently (May 2010) undergoing changes to accommodate the new web publishing features coming in Publican 2.0.


[[Category:Docs Project process]]
[[Category:Docs Project process]]
[[Category:How to]]
[[Category:How to]]

Revision as of 08:22, 29 July 2010

1. Apply to have your document hosted on fedorahosted.org

File a ticket to request hosting from the Fedora Infrastructure team: https://hosted.fedoraproject.org/fedora-infrastructure/newticket

You can find instructions for filling out the ticket here: https://fedorahosted.org/web/new

Note also:

   * Git is the preferred SCM for Fedora Documentation
   * By convention, documentation Git repos are prefaced with docs/, so request docs/Your_Guide.git as the Project Name in the ticket.
   * It's a good idea to recommend a Trac instance so that you can publish some basic details of your project. For example: https://fedorahosted.org/install-guide/ 

2. Add your guide to the Docs Project guides table

When you have some hosting space and have checked in your source code, add your details and details of your guide to the guides table in the Fedora wiki: https://fedoraproject.org/wiki/Docs_Project_guides_table#Guides

3. Add your guide to Transifex

Transifex is the Fedora Project's translation interface.

If you have a stable version of your guide, create a separate branch in which translators can work. This branch is named after the branch of Fedora for which the documentation is to be released. The master branch of your document is used only for developing the English text and should not contain POT or PO files. The process for branching a Fedora document for translation is outlined on the Fedora wiki: https://fedoraproject.org/wiki/Branching_a_document_in_git

The translation branch should contain the Publican pot directory and any language directories that you are importing. You should also run publican update_po to add a few other languages heavily translated in Fedora, including nl-NL (Dutch), pl-PL (Polish), pt-PT (Portuguese), sv-SE (Swedish), and uk-UA (Ukrainian).

When you have created the translation branch, follow the instructions on the Fedora wiki to request the Fedora Localization Team to add it to Transifex: https://fedoraproject.org/wiki/L10N/FAQ#How_do_I_add_a_module_to_Transifex.3F_.28.23add-transifex.29

If your guide is still under development, you do not need to create a branch for translations yet. Wait until you finalise the English content first.

4. Publish your guide on docs.fedoraproject.org

Check out the git repo that holds the content of the docs.fedoraproject.org website:

ssh://USERNAME@git.fedorahosted.org/git/docs/web.git

Build your book in Publican, then insert it into a logical place in the directory structure. Edit the top-level index.html file to link to your book in the formats and languages in which it is available.

This process is currently (May 2010) undergoing changes to accommodate the new web publishing features coming in Publican 2.0.