From Fedora Project Wiki

(Changed the header and removed other instances of "Steering Committee".)
(Fix link to Learn to contribute)
 
(80 intermediate revisions by 24 users not shown)
Line 1: Line 1:
{{header|docs}}
{{header|docs}}
 
{{autolang|base=yes}}
The [[DocsProject | Fedora Documentation Project ("Docs Project")]] provides 100% free/libre open content, services, and tools for documentation.
== Project Details ==
 
{{:Docs Project mission statement}} <!-- no trailing whitespace here -->
 
{|width=100% class="wikitable"
{| border="1"
! width=20% | IRC Channel
| {{fpchat|#fedora-docs}}
|-
! Mailing List
| {{fplist|docs}} - Main Docs Project 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
|Issues are tracked in Pagure repositories listed under [https://pagure.io/projects/fedora-docs/%2A Fedora Docs].  
|-
! Project planning
| [[Docs_Project_meetings#Guides|Current projects]]
|-
|-
|style="background: white; font-weight: bold; font-size: 1.3em; color: white; width: 100%;" | '''[[Docs| Get Docs]]  . . . [[:Category:Draft documentation | Draft Docs]]  . . . [[DocsProject/Translation| Translate Docs]]  . . . [[DocsProject/Join| Join the Team]]  . . . [[Docs_Project_meetings| Docs Meetings]]  '''
! Official Documentation
|}
| https://docs.fedoraproject.org
<!--  ||<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 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]]
|}
|}


== Project Workflow ==
== Find Documentation ==
 
'''I want to...'''
The central project workflow page is [[DocsProject/WorkFlow| DocsProject/WorkFlow]] .
* '''[http://docs.fedoraproject.org find offical Fedora documentation.]'''
 
* '''[[:Category:Documentation|browse unofficial Fedora documentation.]]'''
== The Documents ==
 
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]].
 
If you want to use DocBook XML for Fedora-based documentation, you can learn how using the [http://docs.fedoraproject.org/documentation-guide/ Documentation Guide] and a [http://cvs.fedoraproject.org/viewcvs/example-tutorial/en_US/example-tutorial2.xml?root=docs self-referential example tutorial] which is actually written in DocBook XML itself.  If you want to collaborate with other experienced writers working on official documentation using DocBook XML, you can find the latest in our [http://git.fedorahosted.org/git/docs/ git repositories on Fedora Hosted], or you might choose to resurrect an older document from [[DocsProject/CvsUsage | the Docs Project's CVS repository]].
 
If you prefer to write on the wiki, read the [[DocsProject/Writing_Using_The_Wiki | wiki guide]] that we've prepared.  It shows how to mark up text, where to store pages, and so forth.
 
=== Release Notes "Beats" ===
 
The [[Docs/Beats|  Beats]]  are the living documents that become the release notes for Fedora releases.  The process for creating the release notes is documented on the [[DocsProject/ReleaseNotes/Process| Release Notes process page]].  You can find writers of the Beats on the [[DocsProject/ReleaseNotes/Beats|  Beat Writers]] page.
 
You can help maintain [[Docs/Beats | the Beats]] on the wiki, but you should read the [[Docs/Beats/HowTo| Beat Writing How-To]] first.
 
== 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]]
 
 
{{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 ==
== Help Out ==
'''I want to...'''
* '''[[Reporting problems with Docs|report a problem.]]'''
* '''[[What the Docs Project does|learn what the Documentation Project does.]]'''
* '''[[Join the Docs Project|write or help maintain documentation.]]'''
* '''[https://docs.fedoraproject.org/en-US/fedora-docs/contributing/ learn how to contribute.]'''
* '''[[Docs Project tasks|find a task to work on.]]'''
* '''[[L10N|translate documentation.]]'''


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:Docs Project|*]]
[[Category:Fedora sub-projects]]

Latest revision as of 07:52, 27 February 2019

Project Details

The mission of Fedora's Documentation Project is to improve the overall experience of Fedora users and contributors by providing documentation. We explain how to use certain software and systems, provide written accounts of special events (like releases), and recommend settings for software and systems (in terms of security, performance, and other concerns). In pursuing this work, the Docs Project creates and uses only free and open-source software, content, tools, and processes, so our documentation is reusable, modifiable, and rebuildable by anyone, for free, forever.

IRC Channel #fedora-docs[?]
Mailing List docs - Main Docs Project mailing list
Meetings Weekly at #fedora-meeting[?]
Meeting Time
Next Meeting Agenda
Current issues Issues are tracked in Pagure repositories listed under Fedora Docs.
Project planning Current projects
Official Documentation https://docs.fedoraproject.org
Related page Docs QA -- Documentation QA Team

Find Documentation

I want to...

Help Out

I want to...

Legal

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

Retrieved from "https://fedoraproject.org/w/index.php?title=Docs_Project&oldid=535275"