[openstack-dev] [all][tc] Exposing project team's metadata in README files

Flavio Percoco flavio at redhat.com
Fri Nov 25 12:16:35 UTC 2016

On 25/11/16 12:38 +0100, Flavio Percoco wrote:
>Just a heads up for everyone. The work on this front has moved forward and the
>badges are now being generated as part of the governance CI[0].
>You can find the list of badges here[1] and the pattern is quite obvious, the
>name of the image is based on the project repo name.
>I've edited the README files for all repositories listed in the projects.yaml
>file and I've started to submit these patches[2]. I'm not a fan of "viral
>changes" but I've done my best to explain what's changing, provide references
>and examples on the commit message. These changes are being submitted using the
>tag 'project-badges'[2].

I also wanted to add that these patches are just for projects that are using rst
for their README files (sorry markdown) and that each commit has a preview link
that you can go and look at.

If the layout doesn't look perfect and the whitespace under the svg image
annoyes you, let me tell you that it was improved in the new layout, which is
under review. Also, Github does some funky things to the svg when it renders the
README file, hence the whitespace that was added for the first layout.


>Note that these badges are *JUST* a graphical representation of what's in the
>governance repo. If you don't want to have them in the README file, I guess it's
>fine. I'd, however, encourage everyone to add them to provide consistency and a
>more immediate information of what the project is about, what some of the
>project capabilities are and what its status is.
>Ideally this should also be added in projects documentation as well but I'll
>leave that to every team to do.
>Happy to answer questions,
>P.S: The current layout is being improved[3], if you have better ideas please
>help out.
>[0] https://review.openstack.org/#/c/391588/
>[1] http://governance.openstack.org/badges/
>[2] https://review.openstack.org/#/q/topic:project-badges
>[3] https://review.openstack.org/#/c/399278/
>On 12/10/16 14:50 +0200, Flavio Percoco wrote:
>>One of the common complains about the existing project organization in the big
>>tent is that it's difficult to wrap our heads around the many projects there
>>are, their current state (in/out the big tent), their tags, etc.
>>This information is available on the governance website[0]. Each official
>>project team has a page there containing the information related to the
>>deliverables managed by that team. Unfortunately, I don't think this page is
>>checked often enough and I believe it's not known by everyone.
>>In the hope that we can make this information clearer to people browsing the
>>many repos (most likely on github), I'd like to propose that we include the
>>information of each deliverable in the readme file. This information would be
>>rendered along with the rest of the readme (at least on Github, which might not
>>be our main repo but it's the place most humans go to to check our projects).
>>Rather than duplicating this information, I'd like to find a way to just
>>"include it" in the Readme file. As far as showing the "official" badge goes, I
>>believe it'd be quite simple. We can do it the same way CI tags are exposed when
>>using travis (just include an image). As for the rest of the tags, it might
>>require some extra hacking.
>>So, before I start digging more into this, I wanted to get other opinions/ideas
>>on this topic and how we can make this information more evident to the rest of
>>the community (and people not as familiar with our processes as some of us are).
>>Thanks in advance,
>>[0] http://governance.openstack.org/reference/projects/index.html
>>Flavio Percoco
>Flavio Percoco

Flavio Percoco
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 829 bytes
Desc: not available
URL: <http://lists.openstack.org/pipermail/openstack-dev/attachments/20161125/e71e3a53/attachment.pgp>

More information about the OpenStack-dev mailing list