Expanding the documentation

Connor Imes rocket2dmn at aol.com
Thu Jun 12 18:03:39 UTC 2008

Jim Campbell wrote:
> Hi Phil,
> On Thu, Jun 12, 2008 at 3:35 AM, Phil Bull <philbull at gmail.com
> <mailto:philbull at gmail.com>> wrote:
>     Hi guys,
>     I've created a few Wikipedia-style quality-control banners [1] which
>     could be used for categorising pages with problems. Please let me know
>     what you think.
>     Thanks,
>     Phil
>     [1] - https://wiki.ubuntu.com/Philbull/Test
> Like others have said, I like the wiki banners, too.  "Cleanup
> Required," and, "Style Cleanup," seem to be pretty similar to me, though. 
> Would we have any links included to provide further detail about the
> headings?  Maybe use the bold parts of the heading to link back to a
> wiki page that describes the banner's purpose in greater detail.
> For example, Wikipedia provides a description of what would qualify a
> page as a Candidate for Speedy Deletion [1].  If we're going to use
> these headers, we should provide similar information about what they mean.
> I think using them is a great idea, though.  :)
> Jim
> [1] http://en.wikipedia.org/wiki/Wikipedia:Criteria_for_speedy_deletion

Agreed, I think the banners look nice, but could use a little more
detail.  Linking back to a wiki page would be helpful for this.  Some
other possible categories for banners in order to be more precise:
Deals with Unsupported Version(s) of Ubuntu (similar to Phil's Old
Version tag)
Needs Updating for Latest Version(s) of Ubuntu (say it deals with Gutsy,
but not Hardy - also similar to the Old Version tag)

Also, Candidate for Deletion may want to be expanded to include outdated
material.  Of course, these banners/tags can be mixed and matched on
different pages depending on their content.

All of these should somehow go hand in hand with a CategorySomething
(perhaps included in the banner itself) so it is easy for us to keep
track of what pages are marked with banners by looking at the
CategorySomething page.

Re: Official Documentation sidebar: I don't think this is necessary
unless you are looking to mark certain pages as approved by the Council
or some such thing.  May need to tone it down a bit, as well, it's a
little invasive.

-Connor Imes

More information about the ubuntu-doc mailing list