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

Christopher Aedo doc at aedo.net
Fri Nov 25 17:15:39 UTC 2016

On Fri, Nov 25, 2016 at 3:38 AM, Flavio Percoco <flavio at redhat.com> wrote:
> Greetings,
> 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].
> 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.

Thanks for doing the work to get this automated Flavio!  As a few
others have noted, I did not like the placement at the very top but I
understand it's not reasonably possible to automate this in a way that
find the idea insertion point.  For me at any rate, I've moved them
down to just under the first paragraph explaining the project.

One other important thing that's missing however is the :alt: tag
underneath the image.  For accessibility purposes (and considering
this is all automated anyway) I don't think these badges should be
merged without text describing the image.


> Happy to answer questions,
> Flavio
> 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:
>> Greetings,
>> 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,
>> Flavio
>> [0] http://governance.openstack.org/reference/projects/index.html
>> --
>> @flaper87
>> Flavio Percoco
> --
> @flaper87
> Flavio Percoco
> __________________________________________________________________________
> OpenStack Development Mailing List (not for usage questions)
> Unsubscribe: OpenStack-dev-request at lists.openstack.org?subject:unsubscribe
> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev

More information about the OpenStack-dev mailing list