[all][infra] READMEs of zuul roles not rendered properly - missing content

Brian Rosmaita rosmaita.fossdev at gmail.com
Tue Aug 25 14:16:09 UTC 2020

On 8/24/20 11:05 AM, Clark Boylan wrote:
> On Mon, Aug 24, 2020, at 7:36 AM, Jeremy Stanley wrote:
>> On 2020-08-24 16:12:17 +0200 (+0200), Martin Kopec wrote:
>>> I've noticed that READMEs of zuul roles within openstack projects
>>> are not rendered properly on opendev.org - ".. zuul:rolevar::"
>>> syntax seems to be the problem. Although it's rendered well on
>>> github.com, see f.e. [1] [2].


>> To be entirely honest, I wish Gitea didn't automatically attempt to
>> render RST files, that makes it harder to actually refer to the
>> source code for them, and it's a source code browser not a CMS for
>> publishing documentation, but apparently this is a feature many
>> other users do like for some reason.
> We can change this behavior by removing the external renderer (though I expect we're in the minority of preferring ability to link to the source here).

This may be a bigger minority that you think ... I put up a patch to 
change the default behavior to not render RST, so anyone with a strong 
opinion, please comment on the patch:

> [3] https://opendev.org/opendev/system-config/src/branch/master/playbooks/roles/gitea/templates/app.ini.j2#L88-L95
> [4] https://opendev.org/opendev/system-config/src/branch/master/docker/gitea/Dockerfile#L92-L94
>> -- 
>> Jeremy Stanley

More information about the openstack-discuss mailing list