From Fedora Project Wiki

(→‎Communication Channels: Added Fedora Talk.)
No edit summary
 
(13 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{header|docs}}
[[Category:Fedora sub-projects]]
{{:Docs_Project_mission_statement}}
 
<!--
The Fedora Documentation Project creates, publishes, and maintains the software documentation for the Fedora operating system.
 
{| border="1"
|-
|style="background: white; font-weight: bold; font-size: 1.3em; color: white; width: 100%;" | '''[[Docs| Get Docs]]  . . . [[:Category:Draft documentation | Draft Docs]]  . . . [[Translating documentation| Translate Docs]]  . . . [[Joining the Docs Project| Join the Team]]  . . . [[Docs_Project_meetings| Meetings]]  '''
|}
  ||<tablestyle="width: 95%; cellspacing: 4em; text-align: center;" rowstyle="background: #3074c2; color: white;" style="border: 2px solid #080c30; font-weight: bold; font-size: 2em;"> Join the Docs Project! ||
 
  ||<tablestyle="border=0;" style="font-size: 1.3em; line-height: 1.2em; border=0;"> New reviewers, writers, and editors are '''very''' welcome. <BR> <BR> [[DocsProject/WhyJoin| Why join?]]  | [[DocsProject/NewWriters| Getting started]]  | [[DocsProject/Translation| Translating docs]]  ||
-->
 
<!--
== Contributing roles in the Docs project ==
{{admon/tip|Contributing roles|This is only suggestions for contributing roles. Only your imagination sets the limits. }}
 
{|class="nobordersplz"
|-
|
[[Image:Join_ContentDeveloper.png]]<BR>
[[Join#Content_Writer|Content writer]]
|}
 
{{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.}}
-->
 
== Communication Channels ==
* '''Mailing List:''' For formal discussions, the Fedora Documentation Project uses the [https://www.redhat.com/mailman/listinfo/fedora-docs-list fedora-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 Thursdays at 0001 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.
 
== 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] :
 
[[Legal/Licenses#Documentation]]
 
== Miscellanea ==
 
The following pages collect notes, hints, and other bric-a-brac that would otherwise be lost to the vagaries of the list archive's "search" function.
 
* [[DocsProject/UsefulScripts| Useful scripts]]
 
Check the [[FAQ]]  on this wiki for general information on Fedora and links to other resources.
 
== Stuff ==
The central project workflow page is [[DocsProject/WorkFlow| DocsProject/WorkFlow]] .

Latest revision as of 21:56, 12 June 2010

Pages in category "Docs Project"

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

D