From Fedora Project Wiki

m (Fixed structure)
m (removing main docs proj cat - leaving in sub cats)
 
(9 intermediate revisions by 4 users not shown)
Line 1: Line 1:
= Advancing the Project and Community =
{{admon/note | UNDER REVISION | These notes were created long, long ago and don't accurately reflect Docs Project work flow anymore.  This document is being revised to reflect the adoption of Publican and other changes.}}
 
== Advancing the Project and Community ==


The beauty of FLOSS (''F''ree as in ''L''ivre [Freedom]  ''O''pen ''S''ource ''S''oftware) is the community of creative people involved in the FLOSS movement. They are faced with the same challenges as we face. Likewise, there are many creative and innovative solutions. Now more than ever, it is important to support one another in promoting FLOSS tools to encourage freedom of choice.
The beauty of FLOSS (''F''ree as in ''L''ivre [Freedom]  ''O''pen ''S''ource ''S''oftware) is the community of creative people involved in the FLOSS movement. They are faced with the same challenges as we face. Likewise, there are many creative and innovative solutions. Now more than ever, it is important to support one another in promoting FLOSS tools to encourage freedom of choice.
Line 7: Line 9:
The entire FLOSS community will benefit from a completely "free as in freedom" tool chain for creating, distributing, storing, and publishing FLOSS documents/content.
The entire FLOSS community will benefit from a completely "free as in freedom" tool chain for creating, distributing, storing, and publishing FLOSS documents/content.


== FLOSS Docs the FLOSS Way ==
=== FLOSS Docs the FLOSS Way ===
 
A completely free (as in freedom) and automated toolchain would be of tremendous benefit to the Fedora Project as well as the FOSS community-at-large. To realize this goal, we are proposing an online FLOSS Documentation Tools Summit tentatively planned for the Spring of 2007.
 
-----
In preparation for this event, we need to:
 
* Prepare an agenda for the summit
* Put together a contact list of possible participants from other FLOSS projects
* Publicize the event in the FLOSS community
 
Meanwhile, we also plan to:
 
* Review what are the common FLOSS tools and techniques in use today [''the real'']
* Map out the best documentation workflow [''the ideal'']
* Identify the gaps and how best to fill them [''how to get there from here'']


We hope to arrive at a community-wide consensus on the best way to proceed.
A completely free (as in freedom) and automated toolchain would be of tremendous benefit to the Fedora Project as well as the FOSS community-at-large.  


== Preliminary Questions ==
=== Related Topics For Discussion ===


However, before we get too far down this route, we need to answer some key questions internally:
# Upstream contribution to other documentation projects (for example, GNOME).
 
# Improvements to document conversion tools.
1. How do we want to interact with other content sharing with upstream?
# Better communication (VoIP, online presence tools like Mug<code></code>Shot)
1. What is the nature of what we want to house (be upstream) in the Fedora Project?
# Cross-stream collaboration, working with documentation teams from other projects (such as other distributions and upstream projects) to create or contribute to a documentation commons.
* Artwork, branding, trademarks
# Offline wiki editing, such as using Gedit with the "Tag Lines" plugin. Any popular editor can also be used, as long as tagline features exist or can be easily added.
* Distro specific layer on top of any common documents
# Offline Doc<code></code>Book editing. See [http://wiki.docbook.org/topic/DocBookAuthoringTools/ DocBook Authoring Tools] .
1. What do we want to support as the Fedora project for work going upstream?
# Open<code></code>Office.org and Doc<code></code>Book. See [[DocsProject/OOoDocBook| OOoDocBook]]  and  [http://wiki.docbook.org/topic/OpenOffice/ OpenOffice and DocBook] .
* man/info
* /usr/share/doc/*
* Javadoc, doxygen, etc.
* Other?
1. How do we want to get content moving from "here" to "there"?
* Individual accounts in various systems? (*ick*)
* Through Fedora developers? (better)
* Similar to Fedora Translation now?
* Automagically? (best)
1. What about common toolchains?  Can we get XML or XHTML from everyone and some ability to share content?
* Licensing issues
* SCM and/or
* CMS
1. Other?
 
== Other Related Topics For Discussion ==
 
1. Upstream contribution to other documentation projects (for example, GNOME).
1. Improvements to document conversion tools.
1. Better communication (VoIP, online presence tools like Mug<code></code>Shot)
1. Cross-stream collaboration, working with documentation teams from other projects (such as other distributions and upstream projects) to create or contribute to a documentation commons.
1. Offline wiki editing, such as using Gedit with the "Tag Lines" plugin. Any popular editor can also be used, as long as tagline features exist or can be easily added.
1. Offline Doc<code></code>Book editing. See [http://wiki.docbook.org/topic/DocBookAuthoringTools/ DocBook Authoring Tools] .
1. Open<code></code>Office.org and Doc<code></code>Book. See [[DocsProject/OOoDocBook| OOoDocBook]]  and  [http://wiki.docbook.org/topic/OpenOffice/ OpenOffice and DocBook] .


{|
{|
|-
|-
|[[DocsProject/WorkFlowIdeas| Previous Page - Table of Contents]] ||[[DocsProject/WorkFlowIdeas| Table of Contents]] ||[[DocsProject/WorkFlowIdeas/InnovativeApproaches| Next Page - Innovative Approaches]]
|[[Improving_the_Docs_Project_workflow| Previous Page - Table of Contents]] ||[[Improving_the_Docs_Project_workflow| Table of Contents]] ||[[Improving_the_Docs_Project_workflow_-_Innovative_Approaches| Next Page - Innovative Approaches]]
|}
|}
[[Category:Docs_Project_process]]
[[Category:Improving_the_Docs_Project_workflow]]

Latest revision as of 16:44, 20 May 2009

Note.png
UNDER REVISION
These notes were created long, long ago and don't accurately reflect Docs Project work flow anymore. This document is being revised to reflect the adoption of Publican and other changes.

Advancing the Project and Community

The beauty of FLOSS (Free as in Livre [Freedom] Open Source Software) is the community of creative people involved in the FLOSS movement. They are faced with the same challenges as we face. Likewise, there are many creative and innovative solutions. Now more than ever, it is important to support one another in promoting FLOSS tools to encourage freedom of choice.

The common challenge is to create useful FLOSS documentation in a timely manner. The documentation must be continually updated as the software and projects evolve. It must be simple to understand yet comprehensive. The documentation must be easily translated into dozens of languages. It must be easily revised and distributed in a variety of display and publishing formats (HTML, PDF, PostScript, etc.).

The entire FLOSS community will benefit from a completely "free as in freedom" tool chain for creating, distributing, storing, and publishing FLOSS documents/content.

FLOSS Docs the FLOSS Way

A completely free (as in freedom) and automated toolchain would be of tremendous benefit to the Fedora Project as well as the FOSS community-at-large.

Related Topics For Discussion

  1. Upstream contribution to other documentation projects (for example, GNOME).
  2. Improvements to document conversion tools.
  3. Better communication (VoIP, online presence tools like MugShot)
  4. Cross-stream collaboration, working with documentation teams from other projects (such as other distributions and upstream projects) to create or contribute to a documentation commons.
  5. Offline wiki editing, such as using Gedit with the "Tag Lines" plugin. Any popular editor can also be used, as long as tagline features exist or can be easily added.
  6. Offline DocBook editing. See DocBook Authoring Tools .
  7. OpenOffice.org and DocBook. See OOoDocBook and OpenOffice and DocBook .
Previous Page - Table of Contents Table of Contents Next Page - Innovative Approaches
Retrieved from "https://fedoraproject.org/w/index.php?title=Improving_the_Docs_Project_workflow_-_Advancing_the_Project_and_Community&oldid=102888"