Document how docs team uses the issue
Sheldon Rampton - May 4, 2008 - 16:43
| Project: | Documentation |
| Component: | Misc |
| Category: | bug report |
| Priority: | normal |
| Assigned: | Unassigned |
| Status: | postponed |
Jump to:
Description
I don't understand what the "Component" field means when I submit an issue related to documentation. I've submitted a couple of issues relating to the documentation for using CVS. It's not clear to me whether I should select "Developer guide" or "Documentation in CVS" as the component. Does "Documentation in CVS" mean "documentation about how to use CVS," or "documentation that is being maintained using CVS"?
Perhaps there should be some more documentation about how to submit issues. Right now the main documentation I've been able to find is the "bug reports" node under "contributing to development." However, documentation suggestions aren't really "bug reports," and I couldn't find anything explaining what the different "components" mean.
#1
Sheldon, I agree submitting issues could be easier. It's an important goal for Drupal.org to make this easier. Here's what I suggest you do.
1) Check and see if there is an existing issue addressing this.
2) Post this issue in: http://groups.drupal.org/designers-and-information-architects
3) When a designer gives a mock-up of how it can be improved, the project module maintainers can review it.
Cheers,
Kieran
#2
We would like to include the way that docs uses the issue queue in the new reorg for contributing. Please feel free to help out with sketching out some explanations to be included in the new Documentation section (http://drupal.org/node/240242). Unfortunately docs don't line up well with software tracking. Also reagrding the components not matching up right now (they should match the different books pretty much), we have changed handbook sections around quite a lot and there is an issue to update the components to match (http://drupal.org/node/236767.)
The docs in CVS means exactly that - documentation that is stored and maintained in CVS rather than the handbook, not documentation about CVS. That would be under developer docs currently, but will be moved to the new contributing section once it is created.
I'm going to change this to a docs issue re: documentation.
#3
Part of the problem is that renaming component values is risky (see #140989: need way to rename components safely) in a sense. So, over time, what once might have made sense as a component no longer is as relevant or as descriptive as it once was, yet changing the name of the component may not be a viable option.
#4
The various books have been renamed as well. The current names predate a lot of things. I have some thoughts for later when things settle down but the transition will be gradual