Use of revision tags to track status in gnome-user-docs

Jeremy Bicha jeremy at bicha.net
Sat Apr 23 23:33:53 UTC 2011


On 23 April 2011 19:19, Matthew East <mdke at ubuntu.com> wrote:
> I suggest that we use these to track how many files we have reviewed
> for compatibility with Ubuntu+Unity, how many files have been drafted
> and need peer review, etc. By running the check_status.sh script in
> the gnome-help/C directory, we can see the status of all the pages and
> easily identify what work needs to be done.
>
> The current summary of status is:
>
> == SUMMARY ==
> None:            0
> Stub:            4
> Incomplete:      1
> Draft:           3
> Review:                  16
> Candidate:       13
> Final:           6
> Outdated:                186
>
> Outdated can be used to reflect documents which are in Gnome and which
> need to be checked for compatibility for Ubuntu+Unity.
>
> The total picture looks gloomy but in fact a lot of those files have
> been reviewed and/or can be very quickly reviewed and placed in
> "candidate"or "final" status. If you have already reviewed files for
> compatibility with Ubuntu, please go ahead and amend the status
> accordingly. That will improve the picture quite a lot!
>
> Note: What the various status terms mean is set out here:
> http://projectmallard.org/1.0/mal_info_revision.html
>
> --
> Matthew East
> http://www.mdke.org
> gnupg pub 1024D/0E6B06FF
>
> --
> ubuntu-doc mailing list
> ubuntu-doc at lists.ubuntu.com
> https://lists.ubuntu.com/mailman/listinfo/ubuntu-doc

Ok, to paraphrase this to make sure it's clear. I'll be marking pages as

"review" if I think they're good for Natty
"draft" if more work is needed
"outdated" if it needs to be converted for Natty (most should already
have been marked outdated)

"complete" is after a second person has reviewed and says it's ok
"final" is 3rd look/review ?

And by the way, running yelp --editor-mode shows comments & revision
tags. (Be aware that it also shows .stub's which aren't visible to the
end users.)

Jeremy Bicha




More information about the ubuntu-doc mailing list