On Tue, Jan 3, 2017 at 10:47 AM, Doug Hellmann <d...@doughellmann.com> wrote:
> Excerpts from Anne Gentle's message of 2017-01-03 10:26:28 -0600: > > On Tue, Jan 3, 2017 at 12:04 AM, Andreas Jaeger <a...@suse.com> wrote: > > > > > 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. > > > > > > > To wrap this up - I saw different behavior when simply clicking "New Pull > > Request." The GitHub UI behaves differently for RST files in that > > particular scenario, prior to the act of comparing branches. But it's not > > worthwhile to pursue, and is probably simply a bug in GitHub's UI, so > I've > > abandoned the cookie-cutter patch. > > Ah, that's a case I didn't look at. So you're saying that if we > call it CONTRIBUTING.txt then it renders on the page where the pull > request is being created? That does seem like something we want. > What happens is you get a special notification and link to CONTRIBUTING.txt (or rst, but only after comparing branches) as in this screenshot: https://postimg.org/image/wple5yudr/ But, based on testing, it's fine to keep what we have (rst) for the scenarios that work today. Anne > > Doug > > > > > Anne > > > > > > > > > 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 > > > -- > > > Andreas Jaeger aj@{suse.com,opensuse.org} Twitter: jaegerandi > > > SUSE LINUX GmbH, Maxfeldstr. 5, 90409 Nürnberg, Germany > > > GF: Felix Imendörffer, Jane Smithard, Graham Norton, > > > HRB 21284 (AG Nürnberg) > > > GPG fingerprint = 93A3 365E CE47 B889 DF7F FED1 389A 563C C272 > A126 > > > > > > > > > ____________________________________________________________ > ______________ > > > 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 > > > > > > > __________________________________________________________________________ > 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 > -- Read my blog: justwrite.click <https://justwriteclick.com> Subscribe to Docs|Code: docslikecode.com
__________________________________________________________________________ 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
