From Fedora Project Wiki
(Sorry, I used wrong language version. I reverted the change back) |
|||
| (13 intermediate revisions by 8 users not shown) | |||
| Line 1: | Line 1: | ||
{{autolang|base=yes}} | |||
== 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 == | ||
This wiki is under Creative Commons Attribution-Share Alike 3.0 Unported License (see [FedoraProject:Copyrights | This wiki is under Creative Commons Attribution-Share Alike 3.0 Unported License (see [[FedoraProject:Copyrights]] for details). | ||
== Document formatting == | == Document formatting == | ||
| Line 13: | Line 14: | ||
* The website is in HTML. | * The website is in HTML. | ||
* The guides are developed in XML and converted to HTML and .pdf | * The guides are developed in XML and converted to HTML and .pdf | ||
* Fedora uses Mediawiki [ | * Fedora uses Mediawiki [[Help:Wiki_syntax_and_markup|and uses Mediawiki syntax]] for the wiki pages. | ||
== Suggested Tools == | == Suggested Tools == | ||
* [ | * [[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? | |||
* You may use your [https://fedoraproject.org/wiki/EmailAliases fedoraproject.org email alias] which is granted to you upon successful [https://fedoraproject.org/wiki/Docs_Project_contributor_expectations#Become_a_docs_project_contributor FAS/CLA sign-up.] | * You may use your [https://fedoraproject.org/wiki/EmailAliases fedoraproject.org email alias] which is granted to you upon successful [https://fedoraproject.org/wiki/Docs_Project_contributor_expectations#Become_a_docs_project_contributor FAS/CLA sign-up.] | ||
--> | |||
== Pointers for contributors looking for documents to write == | == Pointers for contributors looking for documents to write == | ||
| Line 27: | Line 30: | ||
* Pick something from [[Docs_Project_admin_tasks_for_new_contributors| the new contributors task list]]. | * Pick something from [[Docs_Project_admin_tasks_for_new_contributors| the new contributors task list]]. | ||
* Check out the [[Docs_Project_meetings#Guides| guides table]] and find a documentation buddy. | * Check out the [[Docs_Project_meetings#Guides| guides table]] and find a documentation buddy. | ||
* The wiki itself needs to be gardened. Check out the [ | * The wiki itself needs to be gardened. Check out the [[:Category:Pages_that_need_love| pages that need love index.]] | ||
* [https://bugzilla.redhat.com/buglist.cgi?query_format=advanced&order=Importance&bug_status=NEW&bug_status=ASSIGNED&classification=Fedora&product=Fedora%20Documentation Go bug hunting.] | * [https://bugzilla.redhat.com/buglist.cgi?query_format=advanced&order=Importance&bug_status=NEW&bug_status=ASSIGNED&classification=Fedora&product=Fedora%20Documentation Go bug hunting.] | ||
* Have some other crazy idea? Great! Let's discuss it on the [https://admin.fedoraproject.org/mailman/listinfo/docs Docs mailing list]. | * Have some other crazy idea? Great! Let's discuss it on the [https://admin.fedoraproject.org/mailman/listinfo/docs Docs mailing list]. | ||
== How it all gets done == | |||
* Check out the Docs Project [[Docs_Project_workflow|workflow]] | |||
Revision as of 19:59, 8 March 2018
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