<div dir="ltr"><br><div class="gmail_extra"><br><div class="gmail_quote">On 30 November 2016 at 12:16, Steve Martinelli <span dir="ltr"><<a href="mailto:s.martinelli@gmail.com" target="_blank">s.martinelli@gmail.com</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"><div dir="ltr">This happened to us for keystone-specs [1]. I settled on removing the reference to the README.rst from the doc folder. You can do the same by removing [2].<div><br></div><div>[1] <a href="https://review.openstack.org/#/c/402878/" target="_blank">https://review.openstack.<wbr>org/#/c/402878/</a></div><div>[2] <a href="https://github.com/openstack/neutron-lib/blob/master/doc/source/readme.rst" target="_blank">https://github.com/<wbr>openstack/neutron-lib/blob/<wbr>master/doc/source/readme.rst</a></div></div></blockquote><div><br></div><div>Thanks Steve, we'll follow suit!</div><div><br></div><div>Cheers,</div><div>Armando</div><div> </div><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"><div class="HOEnZb"><div class="h5"><div class="gmail_extra"><br><div class="gmail_quote">On Wed, Nov 30, 2016 at 2:44 PM, Armando M. <span dir="ltr"><<a href="mailto:armamig@gmail.com" target="_blank">armamig@gmail.com</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"><div dir="ltr"><br><div class="gmail_extra"><br><div class="gmail_quote"><span>On 30 November 2016 at 08:53, Michael Johnson <span dir="ltr"><<a href="mailto:johnsomor@gmail.com" target="_blank">johnsomor@gmail.com</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex">Hi Flavio,<br>
<br>
These tags don't seem to be rendering/laying out well for octavia:<br>
<a href="https://github.com/openstack/octavia/blob/master/README.rst" rel="noreferrer" target="_blank">https://github.com/openstack/o<wbr>ctavia/blob/master/README.rst</a><br>
<br>
Any pointers to get this corrected or is this part of the backend<br>
rendering work you mentioned in the keystone message above?<br>
<span class="m_5851306660934724275m_8007471273847953090gmail-HOEnZb"><font color="#888888"><br></font></span></blockquote><div><br></div></span><div>Actually I just noticed that this may break building docs locally for some envs as I now get in my env:</div>







<p class="m_5851306660934724275m_8007471273847953090gmail-p1"><span class="m_5851306660934724275m_8007471273847953090gmail-s1">Warning, treated as error:</span></p>
<div><span style="font-variant-ligatures:no-common-ligatures;font-family:menlo;font-size:11px">README.rst:None: WARNING: nonlocal image URI found: <a href="http://governance.openstack.org/badges/neutron-lib.svg" target="_blank">http://governance.openstack.or<wbr>g/badges/neutron-lib.svg</a></span></div><div><br></div><div><span style="font-variant-ligatures:no-common-ligatures;font-family:menlo;font-size:11px"></span>I was aware of [1], and I am unsure on the next steps. Can some advise?</div><div><br></div><div>Thanks,</div><div>Armando</div><div><br></div><div>[1] <a href="https://review.openstack.org/#/c/229951/" target="_blank">https://review.openstack.org/#<wbr>/c/229951/</a></div><div><div class="m_5851306660934724275h5"><div> </div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex"><span class="m_5851306660934724275m_8007471273847953090gmail-HOEnZb"><font color="#888888">
Michael<br>
</font></span><div class="m_5851306660934724275m_8007471273847953090gmail-HOEnZb"><div class="m_5851306660934724275m_8007471273847953090gmail-h5"><br>
On Wed, Nov 30, 2016 at 1:34 AM, Flavio Percoco <<a href="mailto:flavio@redhat.com" target="_blank">flavio@redhat.com</a>> wrote:<br>
> On 25/11/16 13:46 +0000, Amrith Kumar wrote:<br>
>><br>
>> Flavio,<br>
>><br>
>> I see a number of patches[1] which have been landed on this project but I<br>
>> find<br>
>> that at least the ones that were landed for Trove, and a random sampling<br>
>> 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<br>
>> first,<br>
>> and most prominent heading, would be the existing heading of the document,<br>
>> 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>
><br>
><br>
> Hi,<br>
><br>
> Some fixes landed yesterday to improve the badges layout. For those<br>
> interested,<br>
> here's an example of what it looks like now:<br>
><br>
> <a href="https://github.com/openstack/keystone" rel="noreferrer" target="_blank">https://github.com/openstack/k<wbr>eystone</a><br>
><br>
> Basically, the horizontal padding was reduced to the minimum needed and the<br>
> badges width was set to the total width of the image.<br>
><br>
> Hope this helps,<br>
> Flavio<br>
><br>
><br>
>> 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<br>
>> the<br>
>> header "Trove" below that.<br>
>><br>
>> In some cases the second header is the same font as the "Team and<br>
>> repository<br>
>> tags" header.<br>
>><br>
>> I think this change (these 124 changes) as proposed are not consistent<br>
>> with<br>
>> the proposal you made below, and certainly seem to be less suitable than<br>
>> that<br>
>> proposal. The end product for the four trove repositories [4], [5], [6],<br>
>> and<br>
>> [7]<br>
>><br>
>> I think we should have a discussion on the ML whether we feel that this<br>
>> 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>
>><br>
>> Thanks,<br>
>><br>
>> -amrith<br>
>><br>
>> [1] <a href="https://review.openstack.org/#/q/topic:project-badges" rel="noreferrer" target="_blank">https://review.openstack.org/#<wbr>/q/topic:project-badges</a><br>
>> [2] <a href="https://github.com/celery/kombu/blob/master/README.rst" rel="noreferrer" target="_blank">https://github.com/celery/komb<wbr>u/blob/master/README.rst</a><br>
>> [3] <a href="https://review.openstack.org/#/c/402547/" rel="noreferrer" target="_blank">https://review.openstack.org/#<wbr>/c/402547/</a><br>
>> [4] <a href="https://gist.github.com/anonymous/4ccf1cc6e531bb50e78cb4d64dfe1065" rel="noreferrer" target="_blank">https://gist.github.com/anonym<wbr>ous/4ccf1cc6e531bb50e78cb4d64d<wbr>fe1065</a><br>
>> [5] <a href="https://gist.github.com/1f38def1c65c733b7e4cec3d07399e99" rel="noreferrer" target="_blank">https://gist.github.com/1f38de<wbr>f1c65c733b7e4cec3d07399e99</a><br>
>> [6] <a href="https://gist.github.com/2f1c6e9b800db6d4a49d46f5b0623c1d" rel="noreferrer" target="_blank">https://gist.github.com/2f1c6e<wbr>9b800db6d4a49d46f5b0623c1d</a><br>
>> [7] <a href="https://gist.github.com/9e9e2e2ba4ecfdece7827082114f8258" rel="noreferrer" target="_blank">https://gist.github.com/9e9e2e<wbr>2ba4ecfdece7827082114f8258</a><br>
>><br>
>><br>
>><br>
>><br>
>>> -----Original Message-----<br>
>>> From: Flavio Percoco [mailto:<a href="mailto:flavio@redhat.com" target="_blank">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 href="mailto:openstack-dev@lists.openstack.org" target="_blank">openstack-dev@lists.openstack<wbr>.org</a>><br>
>>> Subject: Re: [openstack-dev] [all][tc] Exposing project team's metadata<br>
>>> 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),<br>
>>> >> 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<br>
>>> >> 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<br>
>>> >> 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 href="http://governance.openstack.org/reference/projects/index.html" rel="noreferrer" target="_blank">http://governance.openstack.or<wbr>g/reference/projects/index.htm<wbr>l</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>
>>> ><a href="http://github.com" rel="noreferrer" target="_blank">github.com</a>? Would that work for <a href="http://git.openstack.org" rel="noreferrer" target="_blank">git.openstack.org</a>, too?<br>
>>><br>
>>> I don't think it'd work for <a href="http://git.openstack.org" rel="noreferrer" target="_blank">git.openstack.org</a> because it doesn't render<br>
>>> 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<br>
>>> tags<br>
>>> are updated because I'd like for this information to not be duplicated<br>
>>> 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 href="http://git.openstack.org/cgit/openstack/glance/tree/README.rst" rel="noreferrer" target="_blank">http://git.openstack.org/cgit/<wbr>openstack/glance/tree/README.r<wbr>st</a><br>
>>> [1] <a href="https://github.com/celery/kombu/blob/master/README.rst" rel="noreferrer" target="_blank">https://github.com/celery/komb<wbr>u/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<br>
>>> on<br>
>>>   hallway talks.<br>
>>><br>
>>> Flavio<br>
>>><br>
>>> --<br>
>>> @flaper87<br>
>>> Flavio Percoco<br>
><br>
><br>
><br>
><br>
>> ______________________________<wbr>______________________________<wbr>______________<br>
>> OpenStack Development Mailing List (not for usage questions)<br>
>> Unsubscribe: <a href="http://OpenStack-dev-request@lists.openstack.org?subject:unsubscribe" rel="noreferrer" target="_blank">OpenStack-dev-request@lists.op<wbr>enstack.org?subject:unsubscrib<wbr>e</a><br>
>> <a href="http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev" rel="noreferrer" target="_blank">http://lists.openstack.org/cgi<wbr>-bin/mailman/listinfo/openstac<wbr>k-dev</a><br>
><br>
><br>
><br>
> --<br>
> @flaper87<br>
> Flavio Percoco<br>
><br>
> ______________________________<wbr>______________________________<wbr>______________<br>
> OpenStack Development Mailing List (not for usage questions)<br>
> Unsubscribe: <a href="http://OpenStack-dev-request@lists.openstack.org?subject:unsubscribe" rel="noreferrer" target="_blank">OpenStack-dev-request@lists.op<wbr>enstack.org?subject:unsubscrib<wbr>e</a><br>
> <a href="http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev" rel="noreferrer" target="_blank">http://lists.openstack.org/cgi<wbr>-bin/mailman/listinfo/openstac<wbr>k-dev</a><br>
><br>
<br>
______________________________<wbr>______________________________<wbr>______________<br>
OpenStack Development Mailing List (not for usage questions)<br>
Unsubscribe: <a href="http://OpenStack-dev-request@lists.openstack.org?subject:unsubscribe" rel="noreferrer" target="_blank">OpenStack-dev-request@lists.op<wbr>enstack.org?subject:unsubscrib<wbr>e</a><br>
<a href="http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev" rel="noreferrer" target="_blank">http://lists.openstack.org/cgi<wbr>-bin/mailman/listinfo/openstac<wbr>k-dev</a><br>
</div></div></blockquote></div></div></div><br></div></div>
<br>______________________________<wbr>______________________________<wbr>______________<br>
OpenStack Development Mailing List (not for usage questions)<br>
Unsubscribe: <a href="http://OpenStack-dev-request@lists.openstack.org?subject:unsubscribe" rel="noreferrer" target="_blank">OpenStack-dev-request@lists.op<wbr>enstack.org?subject:unsubscrib<wbr>e</a><br>
<a href="http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev" rel="noreferrer" target="_blank">http://lists.openstack.org/cgi<wbr>-bin/mailman/listinfo/openstac<wbr>k-dev</a><br>
<br></blockquote></div><br></div>
</div></div><br>______________________________<wbr>______________________________<wbr>______________<br>
OpenStack Development Mailing List (not for usage questions)<br>
Unsubscribe: <a href="http://OpenStack-dev-request@lists.openstack.org?subject:unsubscribe" rel="noreferrer" target="_blank">OpenStack-dev-request@lists.<wbr>openstack.org?subject:<wbr>unsubscribe</a><br>
<a href="http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev" rel="noreferrer" target="_blank">http://lists.openstack.org/<wbr>cgi-bin/mailman/listinfo/<wbr>openstack-dev</a><br>
<br></blockquote></div><br></div></div>