Problem/Motivation

The documentation at http://drupal.org/documentation has recently been renamed "Community Documentation", and the individual documentation pages within the Community Documentation have been redesigned to encourage editing by the community. At the same time, the Documentation Team (and its leadership) has reduced its Community Documentation responsibilities to oversight and infrastructure improvements, rather than also being responsible for writing and editing the documentation.

In conjunction with that, we are trying to reduce the use of Issues in the Documentation project. So, we need to go through the existing issues in the Documentation project and see if they can be closed or otherwise dealt with.

Remaining tasks

The task of this meta issue is basically to examine Documentation project issues, and either fix up their status, component, etc., or close them (i.e., mark their status as fixed, duplicate, etc.).

Anyone can participate in this cleanup! Here are the steps:

a) Find an open issue in Documentation that hasn't had an update or a reply recently.

b) Go through the Cleanup and Triage sections of the Fixing and responding to Documentation issues page. This is likely going to result in closing the issue, marking it as fixed, or moving it to another project, or in editing the issue title, status, component, etc.

Note for people new to issue management: To change the component, status, title, tags, and other information about an issue, scroll down to the bottom of the issue page. There you will find a Comment form. Above the comment form, you can change the issue's title, component, status, etc. Below the comment form, you will find the "Tags" section, which you can expand in order to add and remove issue tags.

Comments

jhodgdon’s picture

Issue tags: +valid issue

I forgot to tag this issue as "valid". :)

jhodgdon’s picture

Issue summary: View changes

Add note for novice issue queue people

jhodgdon’s picture

Issue tags: +Novice

Also this issue is good for novices. I added some notes for people new to issue queue management to the summary just now too. Thanks to JoeAndrieu for pinging me in IRC to ask for clarification and help, to point out that what I think is obvious isn't necessarily obvious to everyone. :)

JoeAndrieu’s picture

Definitely good for newbies. Thanks for the help jhodgdon!

arianek’s picture

Hey - I'm just wondering what the point of adding "valid issue" is - isn't it just creating another thing to manage? Why not just close any invalid ones and consider open to be valid?

arianek’s picture

Also this is doing awful things to the issue queues of anyone following a large number of Docs issues - every issue being updated is a lot of spam-like updates and makes it easy to miss important issue updates...

jhodgdon’s picture

OK...
My thought in marking things "valid issue" was that we'd know which issues had been looked at and which still needed looking at. Is there a better way to do that? Anyway, I haven't seen many of these coming through. Maybe we should just close this issue and not bother to go through the issue queue. Happy to defer to better wisdom on this...

arianek’s picture

I don't know if there's a better way - probably twice in the last 2+ years, I've just gone through and done a full review of issues and closed any invalid ones, but I think long term using a tag like "valid issue" is kind of meaningless as over time some issues will become invalid and probably not get updated.

The only way to keep track is really to just work on the issues. ;)

jhodgdon’s picture

Yeah... I was trying to recruit some new people to work on issues, and wanted a way for novice people to be able to know "this issue needs triage", as we migrate to not using issues (at least for the most part) for the Community Documentation. Since I didn't get too many takers as far as novice contributors wanting to help clean up the issue queue (or for that matter, non-novice contributors), I guess we should just close this one up, and get rid of that tag.

arianek’s picture

Yah, not to dash the intent of this - I think people reviewing and addressing issues is really good task. But the tagging itself seems like its usefulness will be super short lived vs. the amount of time it takes (and how much it clutters up the queue).

arianek’s picture

Issue summary: View changes

change order of instructions for step (c).

jhodgdon’s picture

Good idea. I've removed the tag from all the instructions (here and on other docs pages). :)

arianek’s picture

Should we close this then?

jhodgdon’s picture

Status: Active » Closed (won't fix)

OK.

jhodgdon’s picture

Issue summary: View changes

Remove idea of tagging the issues.