From Fedora Project Wiki
m (internal link cleaning) |
m (internal link cleaning) |
||
| Line 2: | Line 2: | ||
== Become a docs project contributor == | == Become a docs project contributor == | ||
Before contributing to the [ | Before contributing to the [[DocsProject|Docs Project]] ask yourself [http://fedoraproject.org/wiki/Join_the_Docs_Project#Do_you_want_to_join_the_Docs_Project.3F if you want to join the docs project.] The bare minimum you will need is a [https://admin.fedoraproject.org/accounts Fedora Access System account] (FAS) [[Legal/Licenses/CLA|Fedora Contributor License Agreement]] (CLA). Once you have a FAS account, you will be [http://fedoraproject.org/wiki/EmailAliases granted a fedoraproject.org email alias.] | ||
== On Licensing / Copyrights == | == On Licensing / Copyrights == | ||
| Line 19: | Line 19: | ||
* [[Gobby|Gobby]] is a great real-time documentation collaboration service. | * [[Gobby|Gobby]] is a great real-time documentation collaboration service. | ||
* [ | * [[Publican|Publican]] is a command line tool for converting DocBook XML documents into other formats, such as HTML, PDF, and EPUB. | ||
* Works not directly saved into the wiki should be saved in git via [https://fedorahosted.org/ Fedora Hosted]. | * Works not directly saved into the wiki should be saved in git via [https://fedorahosted.org/ Fedora Hosted]. | ||
<!-- This next step only works if the person is CLA+1 -- i.e. they have to be part of a group. That's not referenced anywhere in our join docs that I can see -- should it be? | <!-- This next step only works if the person is CLA+1 -- i.e. they have to be part of a group. That's not referenced anywhere in our join docs that I can see -- should it be? | ||
Revision as of 20:35, 19 September 2016
Become a docs project contributor
Before contributing to the Docs Project ask yourself if you want to join the docs project. The bare minimum you will need is a Fedora Access System account (FAS) Fedora Contributor License Agreement (CLA). Once you have a FAS account, you will be granted a fedoraproject.org email alias.
On Licensing / Copyrights
This wiki is under Creative Commons Attribution-Share Alike 3.0 Unported License (see FedoraProject:Copyrights for details).
Document formatting
The format depends on the type of document the contributor is writing.
- The website is in HTML.
- The guides are developed in XML and converted to HTML and .pdf
- Fedora uses Mediawiki and uses Mediawiki syntax for the wiki pages.
Suggested Tools
- Gobby is a great real-time documentation collaboration service.
- Publican is a command line tool for converting DocBook XML documents into other formats, such as HTML, PDF, and EPUB.
- Works not directly saved into the wiki should be saved in git via Fedora Hosted.
Pointers for contributors looking for documents to write
- Pick something from the new contributors task list.
- Check out the guides table and find a documentation buddy.
- The wiki itself needs to be gardened. Check out the pages that need love index.
- Go bug hunting.
- Have some other crazy idea? Great! Let's discuss it on the Docs mailing list.
How it all gets done
- Check out the Docs Project workflow