From Fedora Project Wiki

m (→‎Project Administration: Updated the Improving the Docs Project workflow link)
(Fix link to Learn to contribute)
 
(70 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| 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]]
|}
|}


== What we do. ==
== Find Documentation ==
{{:Docs_Project_mission_statement}}
'''I want to...'''
 
* '''[http://docs.fedoraproject.org find offical Fedora documentation.]'''
== How we do it. ==
* '''[[:Category:Documentation|browse unofficial Fedora documentation.]]'''
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 ==
* [[DocsProject/SteeringCommittee/TaskSchedule| 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]]
== 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.]]'''


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]]

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"