[libvirt PATCH] docs: list settings required in creating a new git repo

[Andrea Bolognani]

On Wed, 2020-04-08 at 17:41 +0100, Daniel P. Berrangé wrote:
> +GitLab Configuration
> +====================
> +
> +The `GitLab organization <https://gitlab.com/libvirt>`_ hosts the master copy
> +of all the libvirt Git repositories.
> +
> +When creating a new repository the following changes to the defaults are
> +required under the ``Settings`` page

I think *Settings* would be more appropriate than ``Settings`` in
this context.

Missing ":" after "page".

> +GitHub configuration
> +====================
> +
> +The `GitHub organization <https://github.com/libvirt>`_ hosts read-only
> +mirrors of all the libvirt Git repositories.
> +
> +When creating a new repository the following changes to the defaults are
> +required under the ``Settings`` page

Same comments as the GitLab equivalent.

> +  * **Manage access**
> +
> +    * Add @committers with role "Write"

Probably ``@committers``.

I'd also clarify that this is supposed to be a team, and that it
needs to include ``libvirtmirror``, though assuming that teams are
per-org rather than per-repo then the latter might not be strictly
necessary.

> +libvirt.org
> +===========
> +
> +The `Libvirt project server <https://libvirt.org>`_ hosts read-only mirrors of
> +all the libvirt Git repositories in the directory ``/data/git``.

s/Libvirt/libvirt/

> +When creating a new repository the following steps are required

Missing ":" after "required".

> +* Create repo with
> +  ::
> +
> +     $ sudo su -
> +     # cd /data/git
> +     # mkdir repo.git
> +     # cd repo.git

In the other sections you've used ``$repo``, and it would be nice to
be consistent.

> +     # cd ..
> +     # chown -R gitmirror.gitmirror repo.git
> +     # chmod -R g+w repo.git
> +     # find -type d repo.git | xargs chmod g+s

The ``cd ..`` is not necessary if you just call all follow-up
commands on ``.``, but if you think it makes the example clearer then
I have no objection to leaving it in.

> +* Set the ``description`` and ``config`` files following other repos example

s/repos/repos'/

-- 
Andrea Bolognani / Red Hat / Virtualization