From Fedora Project Wiki

(→‎The Documents: Adding link to documentation category)
(82 intermediate revisions by 26 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}}
|-
|-
|style="background: white; font-weight: bold; font-size: 1.3em; color: white; width: 100%;" | '''[[Docs| Get Docs]] . . . [[Docs/Drafts| Draft Docs]] . . . [[DocsProject/Translation| Translate Docs]]  . . . [[DocsProject/Join| Join the Team]] . . . [[DocsProject/SteeringCommittee| Steering Committee]] '''
! 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
|-
! Project planning
| [[Docs_Project_meetings#Guides|Current projects]]
|-
! Official Documentation
| https://docs.fedoraproject.org
|-
! Related page
| [[Docs QA]] -- Documentation QA Team
|}
|}
<!--  ||<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]]  ||
-->
== Project Workflow ==
The central project workflow page is [[DocsProject/WorkFlow| DocsProject/WorkFlow]] .
== The Documents ==
Published documentation:
* http://docs.fedoraproject.org
* [[:Category:Documentation]]
Draft documentation:
* [[Docs/Drafts| Docs/Drafts]]
Using DocBook XML for Fedora-based documentation:
* http://docs.fedoraproject.org/documentation-guide/
Self-referential example tutorial in XML:
* http://cvs.fedoraproject.org/viewcvs/example-tutorial/en_US/example-tutorial2.xml?root=docs
The latest works-in-progress are always available from our CVS repository:
* [[DocsProject/CvsUsage|  Using the Fedora Documentation Project's CVS Repository]]
=== Release Notes "Beats" ===
The [[Docs/Beats|  Beats]]  are the living documents that become the release notes for Fedora Core.
The process for creating the release notes is documented here:
* [[DocsProject/ReleaseNotes/Process| The Release Notes Process]]
Writers of the Beats can be found here:
* [[DocsProject/ReleaseNotes/Beats|  Beat Writers]]
You can help maintain the Beats here on the wiki:
* [[Docs/Beats|  Beats]]
* [[Docs/Beats/HowTo|  Beat Writing How-To]]
== Other Fedora Documentation ==
Check the [[FAQ]]  on this wiki for general information on Fedora and links to other resources.
== Project Administration ==
* [[DocsProject/Goals| Project goals]]
* [[DocsProject/SteeringCommittee/TaskSchedule| Schedule of tasks]]  to implement the goals
* [[DocsProject/Contributors| A list of our contributors]]
* [[DocsProject/WorkFlowIdeas| Ideas on Improving the Documentation Process Workflow]]
The [[DocsProject/SteeringCommittee| Fedora Docs Project Steering Committee]]  maintains the Project infrastructure, including the DocsProject Wiki pages.
{{Anchor|Documentation_Licensing}}
== Documentation Licensing ==
All documentation produced by Fedora is released under the [http://opencontent.org/openpub Open Publication License] :


[[Legal/Licenses/OPL]]
== Looking for documentation ==
* '''[http://docs.fedoraproject.org I want to find offical Fedora documentation] '''
* '''[[:Category:Documentation|I want to find user guides.]] '''


== Miscellanea ==
== 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.]]'''


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.
== Legal ==
* '''[[Docs_Project_licensing_FAQ|I want to find answers about copyright and licensing of my contributions.]]'''


* [[DocsProject/UsefulScripts| Useful scripts]]  
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].


----
[[Category:Docs Project|*]]
[[Category:DocsProject]]
[[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.