Excerpts from Andreas Jaeger's message of 2017-01-03 07:04:51 +0100: > On 01/03/2017 04:01 AM, Anne Gentle wrote: > > [...] > > Doug, I think the include in Sphinx can be a raw txt file? Then we get > > the best of both worlds - rendered on both docs.openstack.org > > <http://docs.openstack.org> and github.com <http://github.com>. > > We do not need an rst file, github handles .txt just fine. I see no > reason to move to txt. > > > I'll give that a shot with these patches as a proof of concept: > > > > 1. Change cookie-cutter file to CONTRIBUTING.txt > > https://review.openstack.org/416109 > > 2. Update openstack-manuals rendered docs with an included > > CONTRIBUTING.txt https://review.openstack.org/416112 > > > > We won't really know the GitHub UI rendering of the include until > > merged, but I've tested in other repos and changing the file extension > > to .txt gives a link to that file. > > Works with RST as well for me - I just created a pull request for > cookiecutter and got the contributing link as expected. There's no need > to use txt files.
github renders rst to HTML and makes links active. See https://github.com/openstack/oslo.config/blob/master/CONTRIBUTING.rst > > > Thoughts? Please comment on the reviews or here. I can work on it if we > > think it's worthwhile to standardize upon, and/or collaborate with the > > original contributor who wanted to standardize. I do believe the GitHub > > experience is worthy of attention, similar in my mind to the recent > > badges work. > > Andreas __________________________________________________________________________ OpenStack Development Mailing List (not for usage questions) Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
