Category:Docs Project

From FedoraProject

(Difference between revisions)
Jump to: navigation, search
(adding a section on participating, highlighting a link out to the formal content.)
(adding white space, removing cruft content that doesn't point anywhere useful; moved workflow link to appropriate location; removed commented out sections we are not using.)
Line 2: Line 2:
 
{{:Docs_Project_mission_statement}}
 
{{:Docs_Project_mission_statement}}
  
<!--
+
== Where is documentation for using Fedora Linux? ==
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]]  ||
+
-->
+
 
+
== Where is Fedora Documentation? ==
+
  
 
* http://docs.fedoraproject.org - full-length guides
 
* http://docs.fedoraproject.org - full-length guides
 
* http://fedoraproject.org/wiki - wiki (70% contributor-focused, 30% user-focused)
 
* http://fedoraproject.org/wiki - wiki (70% contributor-focused, 30% user-focused)
  
<!--
+
== Participating in the Docs Project ==
== 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.}}
 
{{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.}}
-->
 
 
== Participating in the Docs Project ==
 
  
 
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.
 
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.
Line 50: Line 26:
  
 
== How we do it. ==
 
== 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.
 
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.
 
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. ==
 
== What we are working on now. ==
 +
 
=== Draft and informal documentation ===
 
=== 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]].
 
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 ===
 
=== 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]].
 
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]].
  
Line 72: Line 54:
  
 
=== Task list ===
 
=== 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.
 
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.
  
Line 82: Line 65:
 
== 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] :
+
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]] .
+

Revision as of 22:28, 17 December 2009

DocsProject Header docTeam1.png

The mission of the Fedora Documentation Project is to provide documentation to users and developers to improve the overall usage of Fedora. We do that by explaining the usage of certain pieces of software or systems, provide written accounts of special events (releases, etc), and provide recommendations on setting of software or systems (security, performance, etc).


Contents

Where is documentation for using Fedora Linux?

Participating in the Docs Project

Idea.png
Joining the Documentation Project
To join the Fedora Documentation Project, jump to Joining the Docs Project for details on how to sign up. If you are interested in translating Fedora documentation, jump over to the 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 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 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 Fedora Wiki is used to create draft versions of documentation and also provides a place for non-formal documentation.

Formal documentation

All formal documentation is located at http://docs.fedoraproject.org. These guides are written in DocBook XML and compiled using Publican.

We are working on a number of 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 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 query Bugzilla or use one of the following links to find tickets that are open:

Documentation licensing

All documentation produced by Fedora is released under the Creative Commons Attribution-Share Alike License 3.0 Unported License.

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