<html>
<head>
<meta content="text/html; charset=windows-1252"
http-equiv="Content-Type">
</head>
<body bgcolor="#FFFFFF" text="#000000">
<div class="moz-cite-prefix">Hello Flavio,<br>
<br>
I have two questions on this thread:<br>
<br>
1) I have just written my review on training-guides repository<br>
: <a class="moz-txt-link-freetext" href="https://review.openstack.org/#/c/402607/1">https://review.openstack.org/#/c/402607/1</a> .<br>
Then would you revise your initialized patchset by yourself? Or
Your intention<br>
would be to discuss more on each repository team members and
revise patch(es) by themselves?<br>
<br>
2) Can I18n team (openstack/i18n and openstack/i18n-specs) have
such image tag? :)<br>
<br>
<br>
With many thanks,<br>
<br>
/Ian<br>
<br>
Flavio Percoco wrote on 11/25/2016 11:00 PM:<br>
</div>
<blockquote cite="mid:20161125140012.54m7ie3pmuquvwel@redhat.com"
type="cite">On 25/11/16 13:46 +0000, Amrith Kumar wrote:
<br>
<blockquote type="cite">Flavio,
<br>
<br>
I see a number of patches[1] which have been landed on this
project but I find
<br>
that at least the ones that were landed for Trove, and a random
sampling of
<br>
the others all to be different from what you proposed below[2]
in one
<br>
important aspect.
<br>
<br>
In [2] you proposed a structure where the title of the document;
or the first,
<br>
and most prominent heading, would be the existing heading of the
document, and
<br>
the tags would be below that. In [2] for example, that was:
<br>
<br>
"kombu - Messaging library for Python"
<br>
<br>
and the tags would be in smaller font below that.
<br>
</blockquote>
<br>
Hey Amrith,
<br>
<br>
One reason it's different from Kombu is because Kombu uses shields
as a backend
<br>
for this SVGs, whereas we don't. We generate the badges
ourselves[0], which
<br>
probably ended up in some differences.
<br>
<br>
The other main difference in the kombu case, there are multiple
images in the
<br>
README, wherease in our case there's one SVG containing multiple
svgs. The
<br>
motivation behind this is being able to update the badges without
sending
<br>
patches to projects everytime the governance repo is modified.
<br>
<br>
This layout and format can of couse be modified, the font size and
family can be
<br>
changed, etc. See[1].
<br>
<br>
<blockquote type="cite">What I see in [3] the patch for Trove and
the proposed example [4] is:
<br>
<br>
"Team and repository tags" as the first, and most conspicuous
header, and the
<br>
header "Trove" below that.
<br>
<br>
In some cases the second header is the same font as the "Team
and repository
<br>
tags" header.
<br>
</blockquote>
<br>
I explained this a bit here[2]. The reason for prepending these
secion to the
<br>
README's instead of finding a good place in it is that READMEs
throughout
<br>
OpenStack are quite different from each other and putting this at
the top helped
<br>
in making the process of adding the badges simpler.
<br>
<br>
<blockquote type="cite">I think this change (these 124 changes) as
proposed are not consistent with
<br>
the proposal you made below, and certainly seem to be less
suitable than that
<br>
proposal. The end product for the four trove repositories [4],
[5], [6], and
<br>
[7]
<br>
<br>
I think we should have a discussion on the ML whether we feel
that this new
<br>
structure is the appropriate one, and before some projects
approve these
<br>
changes and others don't that these be all marked WF-1.
<br>
</blockquote>
<br>
I honestly don't think the current proposal is bad, it's different
from Kombu
<br>
for the reasons I mentioned above but it can be improved. Not that
improving the
<br>
badges and their layout doesn't require submitting these patches
again. It'll be
<br>
enough to modify the governance repo that generates these images.
<br>
<br>
Hope this helps,
<br>
Flavio
<br>
<br>
<br>
[0]
<a class="moz-txt-link-freetext" href="http://git.openstack.org/cgit/openstack/governance/tree/doc/source/_exts/badges.py">http://git.openstack.org/cgit/openstack/governance/tree/doc/source/_exts/badges.py</a><br>
[1] <a class="moz-txt-link-freetext" href="https://review.openstack.org/#/c/399278/">https://review.openstack.org/#/c/399278/</a>
<br>
[2]
<a class="moz-txt-link-freetext" href="http://lists.openstack.org/pipermail/openstack-dev/2016-November/107969.html">http://lists.openstack.org/pipermail/openstack-dev/2016-November/107969.html</a><br>
<br>
<blockquote type="cite">Thanks,
<br>
<br>
-amrith
<br>
<br>
[1] <a class="moz-txt-link-freetext" href="https://review.openstack.org/#/q/topic:project-badges">https://review.openstack.org/#/q/topic:project-badges</a>
<br>
[2] <a class="moz-txt-link-freetext" href="https://github.com/celery/kombu/blob/master/README.rst">https://github.com/celery/kombu/blob/master/README.rst</a>
<br>
[3] <a class="moz-txt-link-freetext" href="https://review.openstack.org/#/c/402547/">https://review.openstack.org/#/c/402547/</a>
<br>
[4]
<a class="moz-txt-link-freetext" href="https://gist.github.com/anonymous/4ccf1cc6e531bb50e78cb4d64dfe1065">https://gist.github.com/anonymous/4ccf1cc6e531bb50e78cb4d64dfe1065</a>
<br>
[5] <a class="moz-txt-link-freetext" href="https://gist.github.com/1f38def1c65c733b7e4cec3d07399e99">https://gist.github.com/1f38def1c65c733b7e4cec3d07399e99</a>
<br>
[6] <a class="moz-txt-link-freetext" href="https://gist.github.com/2f1c6e9b800db6d4a49d46f5b0623c1d">https://gist.github.com/2f1c6e9b800db6d4a49d46f5b0623c1d</a>
<br>
[7] <a class="moz-txt-link-freetext" href="https://gist.github.com/9e9e2e2ba4ecfdece7827082114f8258">https://gist.github.com/9e9e2e2ba4ecfdece7827082114f8258</a>
<br>
<br>
<br>
<br>
<br>
<blockquote type="cite">-----Original Message-----
<br>
From: Flavio Percoco [<a class="moz-txt-link-freetext" href="mailto:flavio@redhat.com">mailto:flavio@redhat.com</a>]
<br>
Sent: Thursday, October 13, 2016 7:07 AM
<br>
To: OpenStack Development Mailing List (not for usage
questions)
<br>
<a class="moz-txt-link-rfc2396E" href="mailto:openstack-dev@lists.openstack.org"><openstack-dev@lists.openstack.org></a>
<br>
Subject: Re: [openstack-dev] [all][tc] Exposing project team's
metadata in
<br>
README files
<br>
<br>
On 12/10/16 11:01 -0400, Doug Hellmann wrote:
<br>
>Excerpts from Flavio Percoco's message of 2016-10-12
14:50:03 +0200:
<br>
>> Greetings,
<br>
>>
<br>
>> One of the common complains about the existing
project organization
<br>
>> in the big tent is that it's difficult to wrap our
heads around the
<br>
>> many projects there are, their current state (in/out
the big tent), their
<br>
tags, etc.
<br>
>>
<br>
>> This information is available on the governance
website[0]. Each
<br>
>> official project team has a page there containing the
information
<br>
>> related to the deliverables managed by that team.
Unfortunately, I
<br>
>> don't think this page is checked often enough and I
believe it's not
<br>
>> known
<br>
by everyone.
<br>
>>
<br>
>> In the hope that we can make this information clearer
to people
<br>
>> browsing the many repos (most likely on github), I'd
like to propose
<br>
>> that we include the information of each deliverable
in the readme
<br>
>> file. This information would be rendered along with
the rest of the
<br>
>> readme (at least on Github, which might not be our
main repo but it's the
<br>
place most humans go to to check our projects).
<br>
>>
<br>
>> Rather than duplicating this information, I'd like to
find a way to
<br>
>> just "include it" in the Readme file. As far as
showing the
<br>
>> "official" badge goes, I believe it'd be quite
simple. We can do it
<br>
>> the same way CI tags are exposed when using travis
(just include an
<br>
>> image). As for the rest of the tags, it might require
some extra hacking.
<br>
>>
<br>
>> So, before I start digging more into this, I wanted
to get other
<br>
>> opinions/ideas on this topic and how we can make this
information
<br>
>> more evident to the rest of the community (and people
not as familiar
<br>
with our processes as some of us are).
<br>
>>
<br>
>> Thanks in advance,
<br>
>> Flavio
<br>
>>
<br>
>> [0]
<a class="moz-txt-link-freetext" href="http://governance.openstack.org/reference/projects/index.html">http://governance.openstack.org/reference/projects/index.html</a>
<br>
>>
<br>
>
<br>
>Is your proposal that a tag like
release:cycle-with-milestones would
<br>
>result in a badge being added when the README.rst is
rendered on
<br>
>github.com? Would that work for git.openstack.org, too?
<br>
<br>
I don't think it'd work for git.openstack.org because it
doesn't render the
<br>
README's[0] like github does. One thing I'd like to avoid is
for this
<br>
information to result in new changes to the README file
everytime the tags
<br>
are updated because I'd like for this information to not be
duplicated and
<br>
to
<br>
make it clear that this information is not meant to be updated
manually.
<br>
<br>
Here's[1] an example of what it would look like (or kinda).
<br>
<br>
[0]
<a class="moz-txt-link-freetext" href="http://git.openstack.org/cgit/openstack/glance/tree/README.rst">http://git.openstack.org/cgit/openstack/glance/tree/README.rst</a>
<br>
[1] <a class="moz-txt-link-freetext" href="https://github.com/celery/kombu/blob/master/README.rst">https://github.com/celery/kombu/blob/master/README.rst</a>
<br>
<br>
<br>
>I agree that the governance site is not the best place to
put the info
<br>
>to make it discoverable. Do users look first at the source
repository,
<br>
>or at some other documentation?
<br>
<br>
The feedback* I've gotten is that users normally look at repos
first and
<br>
they
<br>
go from there to docs (which are normally linked in the README
file).
<br>
<br>
* Neither based on a survey nor on any empirical research.
This is based on
<br>
hallway talks.
<br>
<br>
Flavio
<br>
<br>
--
<br>
@flaper87
<br>
Flavio Percoco
<br>
</blockquote>
</blockquote>
<br>
<br>
<br>
<blockquote type="cite">__________________________________________________________________________
<br>
OpenStack Development Mailing List (not for usage questions)
<br>
Unsubscribe:
<a class="moz-txt-link-abbreviated" href="mailto:OpenStack-dev-request@lists.openstack.org?subject:unsubscribe">OpenStack-dev-request@lists.openstack.org?subject:unsubscribe</a>
<br>
<a class="moz-txt-link-freetext" href="http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev">http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev</a>
<br>
</blockquote>
<br>
<br>
<br>
<fieldset class="mimeAttachmentHeader"></fieldset>
<br>
<pre wrap="">__________________________________________________________________________
OpenStack Development Mailing List (not for usage questions)
Unsubscribe: <a class="moz-txt-link-abbreviated" href="mailto:OpenStack-dev-request@lists.openstack.org?subject:unsubscribe">OpenStack-dev-request@lists.openstack.org?subject:unsubscribe</a>
<a class="moz-txt-link-freetext" href="http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev">http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev</a>
</pre>
</blockquote>
<p><br>
</p>
</body>
</html>