[documentation] [Documentation bug] Doc Writer's Guide on Drupal version separation unclear

karldied drupal-docs at drupal.org
Wed Feb 14 22:53:08 UTC 2007


Issue status update for 
http://drupal.org/node/119030
Post a follow up: 
http://drupal.org/project/comments/add/119030

 Project:      Documentation
 Version:      <none>
 Component:    Misc
-Category:     tasks
+Category:     bug reports
 Priority:     normal
-Assigned to:  Anonymous
+Assigned to:  karldied
 Reported by:  Senpai
 Updated by:   karldied
 Status:       active

One set of documentation handbooks, which cover 4.6, 4.7, and 5.x, etc. 


This paragraph was trying to explain: should there be, for a given
topic, one page to explain 4.7 and a separate page for 5.x? Generally
the answer is "no." I'll update to clarify.




karldied



Previous comments:
------------------------------------------------------------------------

Wed, 14 Feb 2007 15:17:55 +0000 : Senpai

On the Documentation Writer's Guide [1] page, there's a paragraph that
makes no sense to me. Am I misunderstanding something here, or should
this be re-written?


"Version separation: It's generally better to have one page for all
Drupal versions, rather than separate pages. Separate version pages are
hard to maintain: when an issue is updated on the page for one version,
it's often neglected on the pages for others. Separate handbooks for
each version are impractical due to the amount of work; a single set of
handbooks is difficult to maintain.

"
Which way should the Version Separation topic lean? Is it good or bad
to have a single set of handbooks?
--
Senpai
[1] http://drupal.org//documentation-writers-guide






More information about the documentation mailing list