From Fedora Project Wiki

m (Updated header links.)
(59 intermediate revisions by 20 users not shown)
Line 1: Line 1:
{{header|docs}}
{{header|docs}}
{{autolang|base=yes}}
== Project details ==


The [[DocsProject | Fedora Documentation Project ("Docs Project")]] provides 100% free/libre open content, services, and tools for documentation.
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).


{|width=100%
! width=20% | Office Hours
| Americas --  Thursdays 1800 UTC
|Europe -- Sundays 1500 UTC (with lnovich)
|APAC -- Not yet scheduled 
|}


{| border="1"
{|width=100%
! width=20% | IRC Channel
| {{fpchat|#fedora-docs}}
|-
! Mailing List
| {{fplist|docs}} - Main Docs Project mailing list <BR> {{fplist|docs-qa}} - Docs QA mailing list
|-
! Meetings
| Weekly at {{fpchat|#fedora-meeting}}<BR>[[Docs_Project_meetings|Meeting Time]]<BR>[[Docs_Project_meetings#Agenda_for_Next_Meeting|Next Meeting Agenda]]
|-
! Current issues
|[https://bugzilla.redhat.com/buglist.cgi?query_format=advanced&classification=Fedora&product=Fedora%20Documentation&bug_status=NEW&bug_status=ASSIGNED Fedora Documentation Bugs] - Reported issues with Official Docs
|-
|-
|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]] '''
! Project planning
|}
| [[Docs_Project_meetings#Guides|Current projects]]
<!--  ||<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! ||
|-
-->
! Official Documentation
<!--  ||<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]]  ||
| https://docs.fedoraproject.org
-->
 
== Contributing roles in the Docs project ==
{{admon/tip|Contributing roles|This is only suggestions for contributing roles. Only your imagination sets the limts. }}
 
{|class="nobordersplz"
|-
|-
|
! Related page
[[Image:Join_ContentDeveloper.png]]<BR>
| [[Docs QA]] -- Documentation QA Team
[[Join#Content_Writer|Content writer]]
|
[[Image:Join_OSDeveloper.png]]<BR>
[[Join#OS_Developer|OS Developer]]
|
[[Image:Join_Translator.png]]<BR>
[[Join#Translator|Translator]]
|
[[Image:Join_WebDeveloper.png]]<BR>
[[Join#Web_Developer_or_Administrator|Web Developer or Administrator]]
|}
|}


== What we do. ==
== Looking for documentation ==
{{:Docs_Project_mission_statement}}
* '''[http://docs.fedoraproject.org I want to find offical Fedora documentation] '''
 
* '''[[:Category:Documentation|I want to find user guides.]] '''
== How we do it. ==
Most of our documentation begins life on the Fedora wiki.  These pages are categorized either as draft ([[:Category:Draft_Documentation]]) or as final ([[:Category:Documentation]]).
 
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. ==
Published documentation can be found on http://docs.fedoraproject.org or on this wiki under [[:Category:Documentation]].  Draft documentation can be found under [[:Category:Draft_Documentation]].
 
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
 
== Project Administration ==
* [[Docs Project tasks| Schedule of tasks]]  to implement the goals
 
* [[Contributors_to_docs_project| A list of our contributors]]
 
* [[Improving_the_Docs_Project_workflow| Ideas on Improving the Documentation Process Workflow]]
 
 
{{Anchor|Documentation_Licensing}}
 
== Documentation Licensing ==
 
All documentation produced by Fedora is released under the [http://opencontent.org/openpub Open Publication License] :
 
[[Legal/Licenses/OPL]]
 
== 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]]
== Ways to help out==
* '''[[Reporting problems with Docs|I want to report a problem.]]'''
* '''[[Join the Docs Project|I want to write or help maintain documentation.]]'''
* '''[[L10N|I want to translate documents.]]'''
* '''[[What the Docs Project does|I want to know what the Documentation Project does.]]'''
* '''[[Docs Project tasks|I want to find a task to work on.]]'''
* '''[[How to contribute to Docs |Learn the processes and start contributing.]]'''


Check the [[FAQ]] on this wiki for general information on Fedora and links to other resources.
== Legal ==
* '''[[Docs_Project_licensing_FAQ|I want to find answers about copyright and licensing of my contributions.]]'''


== Stuff ==
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].
The central project workflow page is [[DocsProject/WorkFlow| DocsProject/WorkFlow]] .


[[Category:Docs Project]]
[[Category:Docs Project|*]]
[[Category:Fedora sub-projects]]

Revision as of 15:26, 27 March 2014

DocsProject Header docTeam1.png

Project details

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).

Office Hours Americas -- Thursdays 1800 UTC Europe -- Sundays 1500 UTC (with lnovich) APAC -- Not yet scheduled
IRC Channel #fedora-docs[?]
Mailing List docs - Main Docs Project mailing list
docs-qa - Docs QA mailing list
Meetings Weekly at #fedora-meeting[?]
Meeting Time
Next Meeting Agenda
Current issues Fedora Documentation Bugs - Reported issues with Official Docs
Project planning Current projects
Official Documentation https://docs.fedoraproject.org
Related page Docs QA -- Documentation QA Team

Looking for documentation

Ways to help out

Legal

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