From Fedora Project Wiki
(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? == | |||
== Where is Fedora | |||
* 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 == | |||
== | |||
{{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.}} | ||
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]. | ||
Revision as of 22:28, 17 December 2009
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.
Where is documentation for using Fedora Linux?
- http://docs.fedoraproject.org - full-length guides
- http://fedoraproject.org/wiki - wiki (70% contributor-focused, 30% user-focused)
Participating in the Docs Project
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.
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.
Subcategories
This category has the following 19 subcategories, out of 19 total.
D
- Docs Project archives
- Docs Project content tasks for experienced contributors
- Docs Project content tasks for new contributors
- Docs Project DE
- Docs Project meetings
- Docs Project meetings/cs
- Docs Project process
- Docs Project tasks
- Documentation
- Documentation beats
- Documentation CMS Option
- Documentation tools
- Draft documentation
Pages in category "Docs Project"
The following 143 pages are in this category, out of 143 total.
*
D
- Desktop Documentation Presentation Options
- Desktop Documentation Presentation Options-Example-desktop
- Desktop Documentation Presentation Options-Example-index
- Desktop Documentation Presentation Options-Example-omf
- Desktop Documentation Presentation Options-Example-spec
- Template:Docs beat closed
- Template:Docs beat converted
- Template:Docs beat open
- Docs FAD 2014
- Meeting:Docs IRC log 20090225
- Meeting:Docs IRC log 20090319
- Docs packages
- Docs Project 14 Release Announcement
- Docs Project admin notes
- Docs Project Focus
- Docs Project guide goals for F14
- Docs Project guide goals for F15
- Docs Project guide goals for F16
- Docs Project IRC channel standard topic
- Docs Project licensing FAQ
- Docs Project licensing FAQ/es
- Docs Project meetings
- Docs Project meetings/cs
- Docs Project mentors
- Docs Project mentors/cs
- Docs Project mission
- Docs Project mission statement
- Docs Project mission statement/cs
- Docs Project mission statement/de
- Docs Project mission statement/es
- Archive:Docs Project Style Guide - Word usage, capitalization, and spelling
- Docs publishers in Koji
- Docs QA
- Docs welcome email
- Docs Workflow-Discussion
- Documentation Amateur Radio Beat
- Documentation Architecture Specific Content Beat
- Documentation Architecture Specific Content Beats
- Documentation ARM Specific Content Beat
- Documentation Backwards Compatibility Beat
- Documentation Beat status
- Documentation Beats Feedback
- Documentation Beats Hardware Overview
- Documentation Beats Installer
- Documentation Beats Overview
- Documentation Beats Welcome
- Documentation Big Data Beat
- Documentation Boot Beat
- Documentation Circuit Design Beat
- Documentation Cloud Beat
- Documentation Cloud Specific Content Beat
- Documentation Cluster Beat
- Documentation Container Beat
- Documentation Database Servers Beat
- Documentation Desktop Beat
- Documentation Development Beat
- Documentation Development D Beat
- Documentation Development Eclipse Beat
- Documentation Development GCC Tools Beat
- Documentation Development Haskell Beat
- Documentation Development OCaml Beat
- Documentation Development Runtime Beat
- Documentation Development Tools Beat
- Documentation Development Web Beat
- Documentation EDA Beat
- Documentation Embedded Development Beat
- Documentation Entertainment Beat
- Documentation Fedora.next Beat
- Documentation File Servers Beat
- Documentation File Systems Beat
- Documentation hosted at Fedora Hosted
- Documentation I18n Beat
- Documentation Installer Beat
- Documentation Java Beat
- Documentation Kernel Beat
- Documentation Legal Beat
- Documentation Live Image Beat
- Documentation Mail Servers Beat
- Documentation Monitoring Beat
- Documentation Multimedia Beat
- Documentation Musicians Beat
- Documentation Networking Beat
- Documentation Printing Beat
- Documentation Productivity Beat
- Documentation Robotics Beat
- Documentation Samba Beat
- Documentation Scientific and Technical Beat
- Documentation Scientific and Technical BeatDocumentation EDA Beat
- Documentation Security Beat
- Documentation Server Configuration Tools Beat
- Documentation Server Specific Content Beat
- Documentation System Daemons Beat
- Documentation Virtualization Beat
- Documentation Web Servers Beat
- Documentation Workstation Specific Content Beat
- Documentation x86 64 Specific Beat
- Documentation x86 Specific Content Beat
- Documentation Xorg Beat