User:Laubersm/Documentation User Guide Update Checklist: Difference between revisions

Latest revision as of 09:24, 18 September 2016

How to do the reviews

Need F14 box (Virtual Machine is fine for most chapters)

Use most current release candidate

Current RC testing progress and howto at Test_Results:Current_Installation_Test

It may also be useful to keep an eye on Common_F14_bugs

The style guide is located....

Things to consider during the review - you don't have to do all of it - team up with someone if your strength is technical fact checking and you need help with the wordsmithing! (or the other way around).

(Re)write Chapter: This stage is for two things: re-fact checking and then editing the formatting and organization of sections so that it lines up with all of our conventions. This could mean anything from fixing headers to putting in admons (like the ones at the bottom of this page) to making sure that the standard installation process is referenced instead of including it inline.
Ideally most rewriting is done between releases (from release to next alpha). There should also be a bugzilla number to track the progress of each idea/request including getting reviews from other teams on technical accuracy. Bugs also help alert new contributors of an opportunity to jump in.

Fact Check: This stage just changes all factual information so that it syncs up with the facts for the upcoming version. If the default browser happens to be Dillo instead of Firefox for this release, the Fact Check stage should reflect this after completion. This is the core of the work during Alpha and with the early release candidates for Beta.
This stage is most commonly tracked in the wiki table. This allows fast updates of what is done and needs to be done when many eyes are working together and does not clutter bugzilla with "see if anything needs to change" bugs.

Edit/Wordsmith: This is for the English majors. Make the page grammatically sound while keeping our conventions and a technical writing style in mind. Extra points go for stylizing the writing as long as it doesn't conflict with the core goals of readability and simplicity in comprehension.

Edit Format/XML Conversion: Make sure it still builds in Publican! This task continues through Beta with any updates as well as ensuring that the translated versions also build without error.

Submitting updates

All edits get done in xml/docbook/git (master branch)

- If you do not have commit access, please submit a git formatted patch to the docs mailing list or in bugzilla

- git diff > mypatch-chaptername

- Then attach mypatch-chaptername

If you submit enough, do not be surprised if you are given commit access.

If you cannot provide a git formatted patch, do not let that stop you, submit suggestions, paragraphs, fixes, anyway possible.

F15 Status table

F14 has been branched for translation. Only drastic "it is really wrong" bug fixes should be applied. All other update should be applied to the master branch for "Next Release"

Please sign your comments

Chapter	Rework suggestions (include bugzilla number)	Alpha fact checking status (in progress, fact checking done, needs wordsmithing,etc)	Ready for translation?
Introduction			N
The Fedora Desktops
Logging into the Desktop
Tour of the GNOME Desktop
Tour of the KDE Desktop
Tour of the Xfce Desktop
Media (Media.xml)	Check live-usb requirements (currently 1G)
Connecting to the Internet (Connecting_to_the_Internet.xml)
Accessing the Web
Communications (Communications.xml)
Printing (Printing.xml)	Does not have Xfce section yet bcotton will add for F15
Office Applications
Financial Software
Playing Multimedia (Playing_multimedia.xml)
Playing games
Managing photos
Sharing your desktop
Customizing the desktop	May want to add new input methods mentioned in the F14 release notes Laubersm
Managing software	really needs more kpackage stuff and some streamlining of the yum to remove duplicate examples Laubersm
Contributors and Revision History	add translators for F14 to list along with F15 editors/writers		No

Other general todo items for UG

~~Add chapter on printing https://bugzilla.redhat.com/show_bug.cgi?id=508025~~ - Thanks bcotton!

Integrate Matthew's updates for
- Finding Software -

~~Update screen shots (desktops) as needed~~ done by bcotton
~~Update Revision History, Book Info, and ent for version 14~~ done Laubersm 20:34, 26 October 2010 (UTC)
~~verify all authors and f13 translators are added to Contributors_and_production_methods.xml and Revision_History.xml~~ Laubersm 19:53, 28 October 2010 (UTC)

General LifeCycle of the User Guide

During Alpha

All new features should be announced and included in the alpha. This is the time to review the User Guide for major changes such as new default applications or major look and feel changes to GNOME, KDE, or other desktops covered.

update and/or close bugs: https://bugzilla.redhat.com/buglist.cgi?query_format=advanced&bug_status=NEW&bug_status=ASSIGNED&bug_status=MODIFIED&bug_status=ON_DEV&bug_status=ON_QA&bug_status=VERIFIED&bug_status=RELEASE_PENDING&component=user-guide&product=Fedora%20Documentation&classification=Fedora

During Beta

Complete the review of all chapters and branch for translation. Since the UG should not change much beyond beta, this document should be branched early in the beta cycle so that translators can get the work done and be ready for the push of more significant document updates such as the installation guide and release notes.

Builds of draft documentation in the languages occurs during this time. Review the builds for xml errors and review bugzilla for content fixes to be made. Correct what is wrong but balance that with minimizing changes that will cause more work for the translation teams.

update and/or close bugs: https://bugzilla.redhat.com/buglist.cgi?query_format=advanced&bug_status=NEW&bug_status=ASSIGNED&bug_status=MODIFIED&bug_status=ON_DEV&bug_status=ON_QA&bug_status=VERIFIED&bug_status=RELEASE_PENDING&component=user-guide&product=Fedora%20Documentation&classification=Fedora

After Release

regularly review bugzilla, update master branch, and close bugs as "next release".

This is the time to do any major rework for the next version. This includes new chapters or major reorganization.

update and/or close bugs: https://bugzilla.redhat.com/buglist.cgi?query_format=advanced&bug_status=NEW&bug_status=ASSIGNED&bug_status=MODIFIED&bug_status=ON_DEV&bug_status=ON_QA&bug_status=VERIFIED&bug_status=RELEASE_PENDING&component=user-guide&product=Fedora%20Documentation&classification=Fedora

Notes to Contributors

Application Installations

Whenever we discuss an application not installed by default, we should put a note about having to install it. The note should look like this:

To install the package claws-mail, read the chapter on managing software. You can install claws-mail by either using the PackageKit application or on the command line by using Yum. More information about Claws Mail is available at: http://claws-mail.org/.

Of course, this should be edited according to the application name, package name, and application home page, but try to use this template for consistency's sake.

Also note that I just made this convention up, so don't feel like you should have known this before. If you have suggestions or comments, let me know.

--Danielsmw 15:08, 25 February 2009 (UTC)

Advanced Topics

Whenever we add something that would be nice to have in the user's guide but isn't necessary for the basic desktop user who just migrated fresh from Windows (example: discussion of FTP programs, advanced discussion of yum on the command line), we should add a template to let the confused user know not to worry about this section if they don't want to. This is what I've come up with right now:

Advanced Usage
This content is written for the more advanced user. It assumes that you are comfortable with the command line and have a relatively good knowledge of Linux terminology. It is probably not necessary to using Fedora as a desktop user, but can help a desktop user expand his or her knowledge base and face more complicated troubleshooting issues.

That, again, is just my current idea until someone suggests or comments on that. Let me know in IRC or on the list. --Danielsmw 15:08, 25 February 2009 (UTC)

admin tasks TODO

Find out where git commits are going - ie not to someplace I am already subscribed to
Figure out Trac. https://fedorahosted.org/userguide/ looks like it was used briefly with F9 wiki -> xml conversion and that is all. Start with can I edit main page or how to I gain access to edit main page.
Create wiki page with procedures and general task lists for managing the user guide. Point to trac and bugzilla and git.
Branch instructions are at: Branching_a_document_in_git
Publishing instructions are at: Publishing_a_document_with_Publican

@@ Line 1: / Line 1: @@
-== Need F13 box (Virtual Machine is fine) ==
+==How to do the reviews==
-Use most current release candidate
+=== Need F14 box (Virtual Machine is fine for most chapters) ===
-Be sure to switch to Beta when available
+*Use most current release candidate
-Current RC testing progress and howto at https://fedoraproject.org/wiki/Test_Results:Current_Installation_Test
+*Current RC testing progress and howto at [[Test_Results:Current_Installation_Test]]
-==submitting updates==
+*It may also be useful to keep an eye on [[Common_F14_bugs]]
-All edits should be done in xml/docbook/git (master branch)
-If you do not have commit access, please submit a git formatted patch to the docs mailing list or in bugzilla
+* The style guide is located....
-git diff > mypatch-chaptername
+*Things to consider during the review - you don't have to do all of it - team up with someone if your strength is technical fact checking and you need help with the wordsmithing! (or the other way around).
-Then attach mypatch-chaptername
+;(Re)write Chapter: This stage is for two things: re-fact checking and then editing the formatting and organization of sections so that it lines up with all of our conventions.  This could mean anything from fixing headers to putting in admons (like the ones at the bottom of this page) to making sure that the standard installation process is referenced instead of including it inline. <p> Ideally most rewriting is done between releases (from release to next alpha).  There should also be a bugzilla number to track the progress of each idea/request including getting reviews from other teams on technical accuracy. Bugs also help alert new contributors of an opportunity to jump in.</p>
-If you submit enough, do not be surprised if you are given commit access.
+;Fact Check: This stage just changes all factual information so that it syncs up with the facts for the upcoming version.  If the default browser happens to be Dillo instead of Firefox for this release, the Fact Check stage should reflect this after completion. This is the core of the work during Alpha and with the early release candidates for Beta. <p> This stage is most commonly tracked in the wiki table. This allows fast updates of what is done and needs to be done when many eyes are working together and does not clutter bugzilla with "see if anything needs to change" bugs. </p>
-If you cannot provide a git formatted patch, do not let that stop you, submit suggestions, paragraphs, fixes, anyway possible.
+;Edit/Wordsmith: This is for the English majors.  Make the page grammatically sound while keeping our conventions and a technical writing style in mind.  Extra points go for stylizing the writing as long as it doesn't conflict with the core goals of readability and simplicity in comprehension.
-==deadlines==
+;Edit Format/XML Conversion: Make sure it still builds in Publican! This task continues through Beta with any updates as well as ensuring that the translated versions also build without error.
-First priority is to get as much content as possible to translators on Thurs April 1 (no fooling).
-best to do lots of easy fixes first.  If you find a section that needs a major rewrite pull it out so that time is not wasted translating it.  We will add it back in a big chunk when it is ready - like we have done with Connecting to Internet already.
+===Submitting updates===
+*All edits get done in xml/docbook/git (master branch)
-==TODO List==
+**If you do not have commit access, please submit a git formatted patch to the docs mailing list or in bugzilla
-* <strike>Update Revision History, Book Info, and ent for version 13 - done</strike>
-* Add in paragraph on changing language input methods https://bugzilla.redhat.com/show_bug.cgi?id=514641
+**git diff > mypatch-chaptername
-** Adding to customizing the desktop - done, proofreading welcome [[User:Laubersm|Laubersm]] 22:13, 31 March 2010 (UTC)
-** <strike>Also check 2.1 Logging In - isn't there a language option on gdm (default) and kdm in addition to desktop optional selection?</strike> There is and reference as been added  [[User:Laubersm|Laubersm]] 20:24, 31 March 2010 (UTC)
-* Check 2.3 - is there a default limit of failed logins before lock out? Common in Enterprisebut I do not think it is set up in Fedora default install. -- There is no mention of it in gdm.schemas [[User:Nathant|Nathant]]
+**Then attach mypatch-chaptername
-* redo Connecting to the Internet for F13 - draft submitted to list by lewis14
+*If you submit enough, do not be surprised if you are given commit access.
+*If you cannot provide a git formatted patch, do not let that stop you, submit suggestions, paragraphs, fixes, anyway possible.
+===F15 Status table===
+F14 has been branched for translation.  Only drastic "it is really wrong" bug fixes should be applied.  All other update should be applied to the master branch for "Next Release"
+<!-- Fact checking during alpha instructions:
+* When you claim a chapter to review, place your name in the column.
+* As you take breaks, update the status.  This way someone else can pick it up if you cannot get back to it.  This is also a where you can indicate that you need some help in the review such as wordsmithing or fixing an xml error.
+* When the review is complete, note that it is ready for translation
+-->
+* Please sign your comments
+{|
+|-
+| Chapter || Rework suggestions (include bugzilla number) || Alpha fact checking status (in progress, fact checking done, needs wordsmithing,etc) || Ready for translation?
+|-
+| Introduction  || || || N
+|-
+| The Fedora Desktops  || || ||
+|-
+| Logging into the Desktop || || ||
+|-
+| Tour of the GNOME Desktop || || ||
+|-
+| Tour of the KDE Desktop ||  || ||
+|-
+| Tour of the Xfce Desktop || ||  ||
+|-
+| Media (Media.xml) || Check live-usb requirements (currently 1G) || ||
+|-
+| Connecting to the Internet (Connecting_to_the_Internet.xml) || || ||
+|-
+| Accessing the Web || || ||
+|-
+| Communications (Communications.xml) ||  || ||
+|-
+| Printing (Printing.xml) || Does not have Xfce section yet [[User:bcotton|bcotton]] will add for F15 || ||
+|-
+| Office Applications ||  ||  ||
+|-
+| Financial Software || || ||
+|-
+| Playing Multimedia (Playing_multimedia.xml) ||  || ||
+|-
+| Playing games || || ||
+|-
+| Managing photos || || ||
+|-
+| Sharing your desktop ||  || ||
+|-
+| Customizing the desktop || May want to add new input methods mentioned in the F14 release notes [[User:Laubersm|Laubersm]] || ||
+|-
+| Managing software || really needs more kpackage stuff and some streamlining of the yum to remove duplicate examples [[User:Laubersm|Laubersm]] || ||
+|-
+| Contributors and Revision History || add translators for F14 to list along with F15 editors/writers || || No
+|}
+===Other general todo items for UG===
+* <strike>Add chapter on printing https://bugzilla.redhat.com/show_bug.cgi?id=508025</strike> - Thanks bcotton!
 * Integrate Matthew's updates for
-** Intro - done, need a proof reading for consistence voice, tense, etc.
+** Finding Software -
-** Office Suites - in progress laubersm
-** Finding Software
+* <strike>Update screen shots (desktops) as needed</strike> done by bcotton
+* <strike>Update Revision History, Book Info, and ent for version 14 </strike> done [[User:Laubersm|Laubersm]] 20:34, 26 October 2010 (UTC)
+* <strike>verify all authors and f13 translators are added to Contributors_and_production_methods.xml and Revision_History.xml</strike> [[User:Laubersm|Laubersm]] 19:53, 28 October 2010 (UTC)
+==General LifeCycle of the User Guide==
+===During Alpha===
+* All new features should be announced and included in the alpha.  This is the time to review the User Guide for major changes such as new default applications or major look and feel changes to GNOME, KDE, or other desktops covered.
+* update and/or close bugs: https://bugzilla.redhat.com/buglist.cgi?query_format=advanced&bug_status=NEW&bug_status=ASSIGNED&bug_status=MODIFIED&bug_status=ON_DEV&bug_status=ON_QA&bug_status=VERIFIED&bug_status=RELEASE_PENDING&component=user-guide&product=Fedora%20Documentation&classification=Fedora
+===During Beta===
+* Complete the review of all chapters and branch for translation.  Since the UG should not change much beyond beta, this document should be branched early in the beta cycle so that translators can get the work done and be ready for the push of more significant document updates such as the installation guide and release notes.
+* Builds of draft documentation in the languages occurs during this time.  Review the builds for xml errors and review bugzilla for content fixes to be made.  Correct what is wrong but balance that with minimizing changes that will cause more work for the translation teams.
+* update and/or close bugs: https://bugzilla.redhat.com/buglist.cgi?query_format=advanced&bug_status=NEW&bug_status=ASSIGNED&bug_status=MODIFIED&bug_status=ON_DEV&bug_status=ON_QA&bug_status=VERIFIED&bug_status=RELEASE_PENDING&component=user-guide&product=Fedora%20Documentation&classification=Fedora
+===After Release===
+* regularly review bugzilla, update master branch, and close bugs as "next release".
+* This is the time to do any major rework for the next version.  This includes new chapters or major reorganization.
+* update and/or close bugs: https://bugzilla.redhat.com/buglist.cgi?query_format=advanced&bug_status=NEW&bug_status=ASSIGNED&bug_status=MODIFIED&bug_status=ON_DEV&bug_status=ON_QA&bug_status=VERIFIED&bug_status=RELEASE_PENDING&component=user-guide&product=Fedora%20Documentation&classification=Fedora
-* Update images of desktops to F13 (verify final artwork for background first!)
+== Notes to Contributors ==
-* Proof read all "Tour of <desktop>" chapters for accuracy with F13 - check version numbers, apps mentioned still exist and as described)
+=== Application Installations ===
-** <strike>GNOME</strike> - patch submitted to mailing list lewis41, applied by [[User:Laubersm|Laubersm]] 16:08, 31 March 2010 (UTC), additional reveiw [[User:Laubersm|Laubersm]] 18:33, 31 March 2010 (UTC) Still needs image updates (separate list item)
+Whenever we discuss an application not installed by default, we should put a note about having to install it.  The note should look like this:
-** KDE
+* To install the package '''claws-mail''', read [[User Guide - Managing Software|the chapter on managing software]].  You can install '''claws-mail''' by either [[User Guide - Managing Software#Installing Software|using the PackageKit application]] or on the command line by [[User Guide - Managing Software#Installing Software 2|using Yum]].  More information about Claws Mail is available at: http://claws-mail.org/.
-** <strike>Xfce</strike> - done [[User:Laubersm|Laubersm]] 19:47, 31 March 2010 (UTC)
+Of course, this should be edited according to the application name, package name, and application home page, but try to use this template for consistency's sake.
+* Also note that I just made this convention up, so don't feel like you should have known this before.  If you have suggestions or comments, let me know.
+--[[User:Danielsmw|Danielsmw]] 15:08, 25 February 2009 (UTC)
-* Proof read all other chapters for accuracy with F13 (app name, menu name and location, major features, etc)
+=== Advanced Topics ===
-** media (burning cd/dvd)
+Whenever we add something that would be nice to have in the user's guide but isn't necessary for the basic desktop user who just migrated fresh from Windows (example: discussion of FTP programs, advanced discussion of yum on the command line), we should add a template to let the confused user know not to worry about this section if they don't want to.  This is what I've come up with right now:
-** accessing the web (firefox and konquer and ftp)
+{{Admon/important|Advanced Usage|This content is written for the more advanced user.  It assumes that you are comfortable with the command line and have a relatively good knowledge of Linux terminology.  It is probably not necessary to using Fedora as a desktop user, but can help a desktop user expand his or her knowledge base and face more complicated troubleshooting issues.}}
-** communications (thunderbird and evolution)
+That, again, is just my current idea until someone suggests or comments on that.  Let me know in IRC or on the list.
-** Financial
+--[[User:Danielsmw|Danielsmw]] 15:08, 25 February 2009 (UTC)
-** Multimedia (music, video)
-** <strike>Games</strike> - done, proofreading welcome. [[User:Laubersm|Laubersm]] 15:47, 31 March 2010 (UTC)
-** Photos -- in progress [[User:Nathant|NathanT]]
-** Sharing the Desktop
-** <strike>Customize the desktop</strike> - adding changing input methods here - done [[User:Laubersm|Laubersm]] 22:13, 31 March 2010 (UTC)
-* Add authors to Contributors_and_production_methods.xml and Revision_History.xml
+== admin tasks TODO ==
+*Find out where git commits are going -  ie not to someplace I am already subscribed to
+*Figure out Trac.  https://fedorahosted.org/userguide/ looks like it was used briefly with F9 wiki -> xml conversion and that is all.  Start with can I edit main page or how to I gain access to edit main page.
+*Create wiki page with procedures and general task lists for managing the user guide.  Point to trac and bugzilla and git.
+*Branch instructions are at: [[Branching_a_document_in_git]]
+*Publishing instructions are at: [[Publishing_a_document_with_Publican]]

Search