[Freeipa-devel] Reviewed-By for design pages?

[Martin Kosek]

On 01/12/2015 09:29 AM, Petr Spacek wrote:
> On 9.1.2015 14:26, Martin Kosek wrote:
>> On 01/07/2015 05:41 PM, Alexander Bokovoy wrote:
>>> On Wed, 07 Jan 2015, Simo Sorce wrote:
>>>> On Wed, 07 Jan 2015 10:34:59 +0100
>>>> Petr Spacek <pspacek at redhat.com> wrote:
>>>>
>>>>> Hello,
>>>>>
>>>>> I wonder if we should add something like Reviewed-by tag to newly
>>>>> created design pages. It would serve as reminder and check that page
>>>>> was really reviewed by someone. (And that we should not spend much
>>>>> time on implementation before the tag is present on the page.)
>>>>>
>>>>> It will also add 'psychological pressure' to the reviewer because his
>>>>> name will be on the design page forever :-)
>>>>>
>>>>
>>>> +1
>>> +1 too.
>>
>> Maybe we could move "author" and "reviewer" to the Feature info box with
>> feature page metadata? (see box e.g. in http://www.freeipa.org/page/V4/OTP)
>>
>> I just wonder that, given that authorship and review is often collaborative
>> work, multiple people may be interested to be listed in these fields in the
>> info box or the page itself.
> 
> Feature box is IMHO a nice idea.
> 
> I was also wondering about templates like {{review_pending}} and
> {{review_done}} with some nice icons - to make obvious if the design is ready
> for implementation or not (yet).
> 
> Review-done icon:
> http://commons.wikimedia.org/wiki/File:Green_tick.svg
> 
> Review-pending icon:
> http://commons.wikimedia.org/wiki/File:Incomplete.svg
> 
> (Both icons are in public domain.)
> 

Thanks for this tip, makes sense. I incorporated the author and reviewer fields
in the Feature box (no additional template needed). See the result:

Missing review box:
http://www.freeipa.org/page/V4/Manage_replication_topology

Completed review:
https://www.freeipa.org/page/V4/Replica_Promotion

The logic is that when "reviewer" field is missing (the default), "missing
reviewer" text appears. When reviewer is added, his name is there.

I am not completely satisfied with the formatting/links of the names though,
currently the code is:

{{Feature|version=TODO|ticket=TODO|author=[[User:SimoSorce|Simo Sorce]],
[[User:MKosek|Martin Kosek]]|reviewer=[[User:MKosek|Martin Kosek]]}}

But it may be better to just use wiki user names and let the template generate
the User page links itself. I.e.:

{{Feature|version=TODO|ticket=TODO|author=SimoSorce, MKosek|reviewer=Mkosek}}