From Fedora Project Wiki

Revision as of 21:12, 25 June 2010 by Jjmcd (talk | contribs) (Note: Source)

Cog.png
This page needs some love
This page should be revised or reconstructed to be more helpful. Problems may include being out of step with current team or project status or process.
DocsProject Header docTeam1.png


Docs Projects

Most of the effort undertaken by the Docs Project is oriented towards producing formal documents. Usually, these are DocBook XML documents rendered in a number of formats using Publican.

In some cases, a draft is produced on the wiki, or content from various subject matter experts is collected on the wiki. In some cases, writers collect data (or perhaps have the expertise or otherwise do research) and write directly to XML.

Documents usually end up being published to http://docs.fedoraproject.org although often they are also packaged and made available through the Fedora repositories.

TLflowLR.png

Announcements

The Docs Project often works with marketing to produce announcements. This work tends to be done almost entirely within the wiki, and rarely, if ever is a formal document produced. Occasionally, the Fedora Design Team will take the wiki document and use it as the basis for a glossy document or brochure. A similar process, obviously without the engagement of Marketing, is used when documenting Docs Project procedures or policies.

Flo-announceLR.png

Release Notes

Release notes, on the other hand, almost always follow the complete process. The only unexploited path is directly writing to DocBook; Release Notes are always developed in the wiki first.

Flo-relnotesLR.png

Guides

Guides are typically not developed in the wiki but rather written straight to DocBook. In addition, Guides are typically not packaged. The emphasis here is on typical, Guides are sometimes packaged and there is no reason input cannot be collected on the wiki.

Flo-guidesLR.png

Access Control

Each of the various repositories has access controlled by some FAS group. Access to the wiki is encouraged, rather than controlled, so access to the wiki is available to anyone who has signed the contributor agreement.

Contributors who have learned to write XML and become familiar with git are entered into the Docs writers group, allowing access to the git repositories. Each document is maintained in a git repository, and the writer group grants access to all of these.

When a contributor has developed the skills necessary to prepare documents for docs.fp.o he is given entry to the publisher's group, which permits committing changes to the Fedora documentation website. If a contributor needs to package a document, the packaged document is submitted for review, and once successfully reviewed, the contributor gets packager privilege, and may push that package to the Fedora repositories.

Docs-permissionsLR.png

Note: Source

The sources for the above images are text:

If you wish to edit the above images, install the Package-x-generic-16.pnggraphiz package and save the text on one of the above pages to a text file. Then execute the command:

  dot -Tpng -o TLflow2.png TLflow2.dot

(or whichever file you select). Edit the source and repeat until the image is how you desire. Note that the various flow- files are copies of TLflow2 with various sections grayed and the size reduced. Then update the source wiki page for those following you, and upload the png to the wiki. Refresh this page and be sure it appears in context correctly.

Old Material still to be incorporated

Wiki - Writing/Drafting

  1. Read DocsProject/WritingUsingTheWiki tells how to structure a document on the Wiki for portability
  2. Know the rules for WikiEditing , and especially the markup rules
  3. Use the writing draft documents page as a reference
  4. Read and understand the style guidelines

Wiki - Publication Method for Formal Documentation

  1. Content is created, worked, and edited for approval in Docs/Drafts/FooGuide as per the flow in Wiki - Writing/Drafting .
    • Editor must be a different person than the writer(s)
  2. Publication editor finalizes, copies to Docs/FooGuide.
  3. Writing team creates Docs/Drafts/<Fedora Ver Num>/FooGuide to work on branch drafts.
  4. Wiki is edited live before conversion to DocBook
  5. Conversion is conducted as per Wiki to DocBook XML
  6. Work for next release continues in Docs/Drafts/.
  7. Request peer review and editing on list.

Wiki to DocBook XML

  1. Document has completed steps in Wiki - Publication Method for Formal Documentation
  2. Edit document to confirm it matches:
  3. Use native MoinMoin tools convert the document to XML and edit the resulting work for DocBook compliance and project norms, as per the wiki to XML conversion how-to .
  4. Follow full steps for getting a CVS module for a Docbook document.

Wiki - Docs Project (e.g. DocsProject/*) Content

  1. Work live in DocsProject/* or in your UserName/ structure
  2. If working in private space, copy over content when ready

There is not much formal process around this. Projects handle this internally, and we trust our own project members to do The Right Thing. Of course, all project members should be watching each other by subscribing to Docs.*.

Full Process Flow, AKA 'From Idea to Document'

  1. A writer posts to fedora-docs-list with an idea or document, and the willingness to maintain it.
  2. If the consensus of the list is that the proposal is feasible, then the writer is assigned an editor and the proposal is registered on the the DocsProject/EditorAssignments Wiki page.
  3. The writer produces an initial draft and submits it to fedora-docs-list . The writer directs any queries or questions either to the mailing list or to the assigned editor. The FDP encourages writers to participate on the mailing list, which is an active forum for help and debate.
    • If the draft is Wiki-based, it should be in Docs/Drafts/ .
    • If the draft is XML-based, it needs a new module in CVS; base the draft on the template in example-tutorial and write to the list when it is ready, so that a CVS admin can respond. Making a module includes creating a bugzilla component for it.
    • In the future, drafts may also be submitted through Plone (CMS) in XHTML or other acceptable formats.
  4. A manager with access-granting privilege creates a container in CVS for the document in progress, and gives the writer CVS access. The assigned manager can assist the writer and editor in ensuring that the document is compatible with the technical requirements of Fedora.
  5. The editor negotiates any work schedule with the writer if necessary. Both may commit revisions during the editorial process, subject to the FDP document lifecycle guidance.
  6. The assigned editor notifies the assigned manager when the document is ready for final review for publication.
  7. Once the writer, editor, and manager agree that the document is complete, it is published on the official Documentation Website .

This process promotes an extremely low barrier to entry. The writer's work may be in any format desired (including plain text) up to the point of final markup, as agreed upon by the editor. The final markup will be in DocBook XML as required in the Documentation Guide. In this way, the writer and the editor form a team with a mentorship aspect, so that the writer learns DocBook XML markup (and hopefully style as well) for more effective document maintenance later.

The Wiki is used as either an interim drafting tool or as a final publishing location. The Wiki is good for very short, one-page how-to pieces, but is not used for maintaining full-length tutorials or guides. If you want to author in the Wiki, you need to use the rules at WikiEditing and WritingUsingTheWiki .

Writers may gain access to additional document containers by providing substantial improvements to those documents in association with their writers, editors, and managers. The definition of substantial is left to the editors and managers for each document, to provide maximum fluidity. Regular contributors may be added to a list of "power writers/editors" with access to all other containers.

Withdrawing a Proposed Document

A writer may email their editor and withdraw proposals or documents in progress without any prejudice. The FDP recognizes that sometimes changing circumstances result in work delays or cancellations, through no fault of the writer. It is far better to cancel than to just drop the work or disappear. The first shows maturity as a contributor, the second and third make people not willing to trust you in the future.

Fedora is a dynamic project that aims for both open participation and high standards. For these reasons, editors and managers may ask writers to amend their drafts before accepting them. If the writer does not respond, or no agreement can be reached, then the editor may request that the proposal or documents in progress be withdrawn.

The FDSCo must be made aware of withdrawals. Once a withdrawal is known, the editor then moves to close the bug component and informs the writer by email. Once a proposal or document in progress has been withdrawn, other writers may submit their own proposals for the same subject. Naturally, anyone is welcome to use the in-progress work and continue with it, as long as the work has been correctly contributed to the project and is therefore under the CC-BY-SA.

Important.png
Canonical documents, such as the Documentation Guide, or other high-risk content areas are somewhat more closely controlled.

Other Projects

Other projects are welcome to use these methodologies/workflows. Any that wish to have their documentation be formally part of the FDP set should contact [docs@lists.fedoraproject.org] .

XML - DocBook Publication Method

EditingFedoraRedhatCom

http://fedoraproject.org/wiki/DocsProject/Tasks

Getting a Document Translated

  1. Author or convert guide to XML
  2. Use XML toolchain to generate the PO file (make po)
  3. Refer to fedora-docs-list for latest process to get PO files into L10n channels .

Orphaning Documents

Refer to Full Process Flow for a complete explanation.
https://fedoraproject.org/w/index.php?title=Docs_Project_workflow&oldid=182225
fedoraproject.org
crawl=CC-MAIN-2019-26
37873
application/http; msgtype=response
sha1:QQUMIQQJ7N62HWO2J5L3BIG5LYJPY5SD
<urn:uuid:53cf0917-9bba-4db7-b720-743b062bc6e7>
2019-06-16T23:21:24Z
8.43.85.67
text/html
sha1:JDA7EABNWN6PZ6XWCPPR26FY6XFWEHYR
<urn:uuid:0f819b3f-09ce-465f-b29b-2f2177511b61>
https://fedoraproject.org/w/index.php?title=Docs_Project_workflow&oldid=182225
response
<urn:uuid:d392e1ae-adf8-477d-a1b8-3c9084348291>
isPartOf: CC-MAIN-2019-26
publisher: Common Crawl
description: Wide crawl of the web for June 2019
operator: Common Crawl Admin (info@commoncrawl.org)
hostname: ip-10-156-104-6.ec2.internal
software: Apache Nutch 1.15 (modified, https://github.com/commoncrawl/nutch/)
robots: checked via crawler-commons 1.1-SNAPSHOT (https://github.com/crawler-commons/crawler-commons)
format: WARC File Format 1.1
conformsTo: http://iipc.github.io/warc-specifications/specifications/warc-format/warc-1.1/