[drupal-docs] Tag handbook pages with major versions

Charlie Lowe cel4145 at cyberdash.com
Wed Sep 14 13:31:52 UTC 2005


{bump}

* Do we just want to include a statement like

"This documentation applies to Drupal 4.x-4.y"

Any better suggestions for how to word this?

* Should it be styled in the handbook pages? Not the same as but similar 
to the moderation message:

http://drupal.org/node/30783

Italicized? Bolded? Consider that the text will also be in pdf and other 
offline versions

* Should it definitely go at the beginning of the text, or be considered 
  more of an endnote?

Charlie Lowe wrote:
> I think we could all agree that
> 
> 1) providing version information about the documentation is important
> 2) we need "freezes" of the handbook for different releases
> 
> As to how to implement the versions, some seem to like tagging with 
> taxonomy; some in text. Now currently, we can easily provide a docbook 
> XML freeze of the handbook at any time, and when Djun has the time, a 
> pdf version. *If* we tag the documentation using taxonomy, I know that 
> printer-friendly versions of the collaborative book in 4.6 do not 
> include taxonomy tags. Assuming that this is the same for 4.7 and for 
> the docbook xml output (is it?), it will be better if we include the 
> version information in text.
> 
> If this is the case, let's move forward with a format for the version 
> information. Any suggestions? We need a standard for this.
> 
> Also, Farsheed made the suggestion that
> 
> "we not worry about going back and tagging the existing pages in the 
> handbook (or tagging at all really), but rather focus on agreeing to a 
> forward thinking way to manage the handbook, especially as 4.7 comes out."
> 
> I agree. Let's shoot for updating as we go. Once we have a format for 
> providing version information and it is available in the handbook 
> documentation, we also need to notice it to the rest of the community. 
> In that notice, we can make a request for handboook page authors to 
> update their pages with version information at their convenience.
> 
> Once the community has been noticed, any new or revised moderated 
> handbook pages should be left moderated until that version information 
> is provided. We make this the standard and stick to it and people will 
> quickly catch on. Of course, anyone on the doc team that wants to is 
> welcome to update any pages that they like. So let's not see this as a 
> "tagging sprint" but rather make this an ongoing effort that makes it 
> the responsibility of anyone creating or revising handbook pages.



More information about the drupal-docs mailing list