Re: [libvirt PATCH] docs: introduce a page showing a overall CI dashboard

[Andrea Bolognani <abologna@xxxxxxxxxx>]

On Mon, 2020-05-04 at 13:35 +0100, Daniel P. Berrangé wrote:
> +The dashboard below shows the current status of the GitLab CI jobs for each
> +repository:
> +
> +.. raw:: html
> +
> +       <tr>
> +         <th colspan="2">Language bindings</th>
> +       </tr>
> +       <tr>
> +         <td>libvirt-csharp</td>
> +         <td>
> +           <a href="https://gitlab.com/libvirt/libvirt-csharp/pipelines";>
> +             <img alt="pipeline status" src="https://gitlab.com/libvirt/libvirt-csharp/badges/master/pipeline.svg"/>
> +           </a>
> +         </td>
> +       </tr>
> +       <tr>
> +         <td>libvirt-go</td>
> +         <td>
> +           <a href="https://gitlab.com/libvirt/libvirt-go/pipelines";>
> +             <img alt="pipeline status" src="https://gitlab.com/libvirt/libvirt-go/badges/master/pipeline.svg"/>
> +           </a>
> +         </td>
> +       </tr>

Using raw HTML is not great. I suggest we do something like

  .. list-table::
     :widths: 80 20
     :header-rows: 1

     * - Language binding
       - GitLab CI

     * - libvirt-csharp
       - .. image:: https://gitlab.com/libvirt/libvirt-csharp/badges/master/pipeline.svg
            :target: https://gitlab.com/libvirt/libvirt-csharp/pipelines
            :alt: libvirt-csharp pipeline status

     * - libvirt-go
       - .. image:: https://gitlab.com/libvirt/libvirt-go/badges/master/pipeline.svg
            :target: https://gitlab.com/libvirt/libvirt-go/pipelines
            :alt: libvirt-go pipeline status

with a separate table for each category instead.

The rows in the resulting tables are much thicker, but that's
something that we should address in our CSS anyway, since this is not
the only place where we're using reStructuredText tables.

> +         <td>ruby-libvirt</td>
> +         <td>
> +           <a href="https://gitlab.com/libvirt/ruby-libvirt/pipelines";>
> +             <img alt="pipeline status" src="https://gitlab.com/libvirt/ruby-libvirt/badges/master/pipeline.svg"/>
> +           </a>
> +         </td>

Unrelated, but why is this repository not called libvirt-ruby?

> +         <td>test</td>
> +         <td>
> +           <a href="https://gitlab.com/libvirt/test/pipelines";>
> +             <img alt="pipeline status" src="https://gitlab.com/libvirt/test/badges/master/pipeline.svg"/>
> +           </a>
> +         </td>

This is just a test repository and should not show up in the
dashboard in my opinion.

> +       <tr>
> +         <th colspan="2">Archived</th>
> +       </tr>

I think the "Archived" section should not exist right now. Once we
start archiving projects that used to have a proper GitLab CI
configuration, then maybe, but that's not the case right now.

-- 
Andrea Bolognani / Red Hat / Virtualization