Documentation taxonomy?

View: New views
3 Messages — Rating Filter:   Alert me  

Documentation taxonomy?

by Addison Berry-2 :: Rate this Message:

Reply to Author | View Threaded | Show Only this Message

This was an idea raised during the August 8 IRC meeting. One thing  
that was pointed out is that we will probably need to create some  
pages as stub pages while we are in the process of getting the new  
Getting Involved handbook together. It would be great if there was a  
way for us to mark those stub pages so that it would be easy for the  
docs team to have an automated list of them rather than us needing to  
manually keep a list to refer back to as we work through them.

If we created a "documentation" vocabulary that had terms like stub,  
outdated, insecure code, etc. That would a) let us flag things so they  
would be easy to generate lists and b) maybe let us do some theme  
changes on those pages so we can easily indicate to readers the status  
of a handbook page. I think this could be quite cool, but I'm sure  
there are drawbacks to it as well. The main negative that I can think  
of is that it will clutter the node add/edit form even more and may  
confuse newbies if they feel like they *should* be selecting something  
but aren't sure what they are doing with it.

So, anyway, what do you think? DISCUSS. ;-)

- Addi (aka add1sun)
--
Pending work: http://drupal.org/project/issues/documentation/
List archives: http://lists.drupal.org/pipermail/documentation/

Re: Documentation taxonomy?

by Benjamin Melançon-3 :: Rate this Message:

Reply to Author | View Threaded | Show Only this Message

All for using taxonomy to flag more information about handbook pages.
If we can add this customization to drupal.org the vocabulary could be
de-emphasized with theming (or just moved down with form_alter) or
even hidden from some roles on the node add/edit page.

(For presentation of information regarding assigned terms, an
alternative to theming is http://drupal.org/project/term_message which
was written for documentation purposes and I'd rewrite it to meet any
handbook needs.)

benjamin

Agaric Design Collective
Open Source Free Software Web Development
http://agaricdesign.com/
--
Pending work: http://drupal.org/project/issues/documentation/
List archives: http://lists.drupal.org/pipermail/documentation/

Re: Documentation taxonomy?

by Addison Berry-2 :: Rate this Message:

Reply to Author | View Threaded | Show Only this Message

I, too, was originally thinking that we could form_alter the select  
list out for regular users but I guess depending on what we put in  
there it may be useful to let users flag pages as well. This wouldn't  
make much sense now probably but *if* we decide to open editing to  
regular users, it would make more sense. I still lean towards removing  
it but want to leave the option open if people feel strongly one way  
or the other.

I have created an issue in the queue (http://drupal.org/node/304826)  
about this so we can define what terms should be in the list.  
Everyone, let's  hammer on it and come up with a good, tight list of  
terms and then we can move it on to the webmasters queue for  
implementation.

Benjamin, I've added your module to the list of modules for review for  
docs team use, particularly in light of the coming redesign. I'll  
carry that conversation itself to another thread though.

Thanks for the feedback!
- Addi (add1sun)


On Aug 28, 2008, at 4:38 AM, Benjamin Melançon wrote:

> All for using taxonomy to flag more information about handbook pages.
> If we can add this customization to drupal.org the vocabulary could be
> de-emphasized with theming (or just moved down with form_alter) or
> even hidden from some roles on the node add/edit page.
>
> (For presentation of information regarding assigned terms, an
> alternative to theming is http://drupal.org/project/term_message which
> was written for documentation purposes and I'd rewrite it to meet any
> handbook needs.)
>
> benjamin
>
> Agaric Design Collective
> Open Source Free Software Web Development
> http://agaricdesign.com/
> --
> Pending work: http://drupal.org/project/issues/documentation/
> List archives: http://lists.drupal.org/pipermail/documentation/

--
Pending work: http://drupal.org/project/issues/documentation/
List archives: http://lists.drupal.org/pipermail/documentation/
LightInTheBox - Buy quality products at wholesale price!