My favorites | Sign in
Project Home Downloads Wiki Issues Source
New issue   Search
for
  Advanced search   Search tips   Subscriptions
Issue 3706: Add "Affects Docs" setting.
7 people starred this issue and may be notified of changes. Back to list
Status:  WontFix
Owner:  ----
Closed:  Dec 3


Sign in to add a comment
 
Reported by tnor...@google.com, Dec 1, 2015
For each release, our docs team would like to know what has changed. 

We've discussed ways we could generate this data, and one promising approach is if gerrit could have a "Affects Docs" checkbox. When developers are making changes that have docs impact (e.g. changing UI, or fixing something we think should be documented), they can mark that flag on the CL -- or reviewers, who spot that there's a potential docs impact, could also suggest the flag be checked.

At release time (or more regularly for that matter), we can query gerrit for affects-docs CLs, and generate a list of changes (or describe them at a high level by looking at the git commit message and/or code changes if necessary for context).

Another way we could do this would be to use an issue tracker label for the same purpose, but we have a lot of changes that don't have a corresponding issue tracker entry, and there aren't "reviewers" for the bug who could spot that you forgot to mark a change as docs-relevant etc.
Dec 2, 2015
#1 icee...@googlemail.com
Hi,

This seems like it could be done by just adding a non-blocking label
(see https://gerrit-review.googlesource.com/Documentation/config-labels.html).

Björn
Dec 2, 2015
#2 tnor...@google.com
Yes indeed, that looks like a simple way to get the same result; I've redirected my request to our gerrit administrators instead.  You can close this as already supported by gerrit custom labels.
Dec 3, 2015
Project Member #3 david.pu...@sonymobile.com
Per previous discussion.  This is already supported by custom labels.

FWIW there are other ways too.  For example Openstack has a custom workflow for changes with documentation impact:

https://wiki.openstack.org/wiki/Documentation/DocImpact

Status: WontFix
Sign in to add a comment

Powered by Google Project Hosting