Category:Docs Project

From FedoraProject

(Difference between revisions)
Jump to: navigation, search
m (Updated weekly meeting time from Thursdays to Wednesdays.)
 
(7 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{header|docs}}
+
[[Category:Fedora sub-projects]]
{{:Docs_Project_mission_statement}}
+
 
+
== Where is documentation for using Fedora Linux? ==
+
 
+
* http://docs.fedoraproject.org - full-length guides
+
* http://fedoraproject.org/wiki - wiki (70% contributor-focused, 30% user-focused)
+
 
+
== Participating in the Docs Project ==
+
 
+
{{admon/tip|Joining the Documentation Project| To join the Fedora Documentation Project, jump to [[Joining_the_Docs_Project| Joining the Docs Project]] for details on how to sign up. If you are interested in ''translating'' Fedora documentation, jump over to the [[L10N|L10n (localization) Project's]] wiki pages.}}
+
 
+
If you are interested in participating in some aspect of the Docs Project, you need a Fedora account, to introduce yourself to the team, and talk about what you want to do.
+
 
+
How can you help?  Collaborating on existing works, writing new content, editing and providing feedback on existing and draft content, and working on the wiki team.
+
 
+
What can you do?  Some examples:  edit existing wiki pages; draft documents on the wiki; find problems in existing docs and report or fix them; work on formal docs in Subversion or git repositories; collaborate with other Fedora teams or hosted projects.
+
 
+
The full steps are in [[Joining the Docs Project]].
+
 
+
== Communication channels ==
+
* '''Mailing List:''' For formal discussions, the Fedora Documentation Project uses the [https://admin.fedoraproject.org/mailman/listinfo/docs docs] mailing list.
+
* '''IRC:''' For informal discussions about Fedora Documentation, many members of the project frequent the '''#fedora-docs''' channel on '''irc.freenode.net'''.
+
* '''Talk:''' For project discussions we sometimes use the [[Fedora Talk]] VoIP system.  Our conference room is ''2008''.
+
* '''Meetings:''' Weekly Fedora Documentation Project meetings are held on Wednesdays at 2300 UTC, in the '''#fedora-meeting''' channel on '''irc.freenode.net'''. Check out the [[Docs_Project_meetings| Meetings]] wiki page for past meetings minutes, and the agenda for the upcoming meeting.
+
 
+
== How we do it. ==
+
 
+
Documents typically begin life on the Fedora wiki.  This is to aid the development of the document until it can be finalized.  Unfinished documents are categorized as [[:Category:Draft_Documentation]].  Once the document is deemed complete, the Draft_Documentation category is replaced by the [[:Category:Documentation]] category.
+
 
+
If the documentation is deemed to be "official" and in need of a more permanent home, the wiki pages are translated into Docbook XML of which can then be used to generate HTML and RPM files that are used to disseminate to the public.  HTML files are published at http://docs.fedoraproject.org and RPM files are published in the Fedora repository.
+
 
+
More details are found on the [[Docs Project workflow]] page.
+
 
+
== What we are working on now. ==
+
 
+
=== Draft and informal documentation ===
+
 
+
The [http://fedoraproject.org/wiki Fedora Wiki] is used to create [[:Category:Draft_Documentation | draft versions]] of documentation and also provides a place for [[:Category:Documentation | non-formal documentation]].
+
 
+
=== Formal documentation ===
+
 
+
All [[Docs_Project_guides | formal documentation]] is located at [http://docs.fedoraproject.org http://docs.fedoraproject.org].  These guides are written in [[DocBook]] XML and compiled using [[Publican]].
+
 
+
We are working on a number of [[Docs Project guides | guides]] that aid users in setting up and using Fedora:
+
* Installation Guide
+
* Release Notes
+
* Security Guide
+
* SELinux Guide
+
* User Guide
+
* Deployment Guide
+
* RPM Guide
+
* Amateur Radio Guide
+
 
+
=== Task list ===
+
 
+
We use [http://bugzilla.redhat.com Red Hat's Bugzilla instance] for tracking issues and tasks within the Docs Project.  It is always helpful to provide input and patches to bugs.
+
 
+
You can [https://bugzilla.redhat.com/query.cgi query] [https://bugzilla.redhat.com/ Bugzilla] or use one of the following links to find tickets that are open:
+
* [https://bugzilla.redhat.com/buglist.cgi?query_format=advanced&classification=Fedora&product=Fedora%20Documentation&bug_status=NEW New tickets that have not been assigned].
+
* [https://bugzilla.redhat.com/buglist.cgi?query_format=advanced&classification=Fedora&product=Fedora%20Documentation&bug_status=NEW&bug_status=ASSIGNED All tickets, new and assigned, that have not been closed].
+
 
+
{{Anchor|Documentation_Licensing}}
+
 
+
== Documentation licensing ==
+
 
+
All documentation produced by Fedora is released under the [http://creativecommons.org/licenses/by-sa/3.0/ Creative Commons Attribution-Share Alike License 3.0 Unported License].
+

Latest revision as of 21:56, 12 June 2010

Pages in category "Docs Project"

The following 124 pages are in this category, out of 124 total.

*

A

C

D

D cont.

D cont.

E

F

H

I

J

M

P

R

S

U

W