An issue tracker for documentation
We’ve been discussing on-and-off an issue tracker for documentation. We’re reaching the point at which we need to make this happen. This will solve two problems:
- people want to contribute to docs but don’t have a central list of tasks that they can sit down and tackle
- more and more contributor days are happening and our issue tracker will be a place where organisers can find tasks for the day
What’s the issue tracker for?
The issue tracker is a central place where people can report issues related to documentation (kind of like trac, but for docs). Examples:
- reporting an out-of-date example in the code reference
- reporting a page in a handbook that needs copy-edited
- reporting a page of content that hasn’t been updated to the latest WordPress version
Essentially, it’s for bugs with documentation.
How would it work?
A person is working with the documentation and wants to report an issue. We provide a place for them to do this, with an appropriate tag applied to the report. This could even be built into documentation pages so that they don’t have to leave the page they’re on.
The report would go into the tracker, which would generate a list of issues (at make/docs/issues, for example). These would be tagged and an interested person could click the tag to bring up a list of issues for that tag.
Or, it doesn’t need to be done that way but that’s how it is in my head.
If anyone has any suggestions on how we could implement this please let me know in the comments.