<div dir="ltr"><br><div class="gmail_extra"><br><div class="gmail_quote">On Tue, Jan 3, 2017 at 12:04 AM, Andreas Jaeger <span dir="ltr"><<a href="mailto:aj@suse.com" target="_blank">aj@suse.com</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">On 01/03/2017 04:01 AM, Anne Gentle wrote:<br>
> [...]<br>
<span class="">> Doug, I think the include in Sphinx can be a raw txt file? Then we get<br>
> the best of both worlds - rendered on both <a href="http://docs.openstack.org" rel="noreferrer" target="_blank">docs.openstack.org</a><br>
</span>> <<a href="http://docs.openstack.org" rel="noreferrer" target="_blank">http://docs.openstack.org</a>> and <a href="http://github.com" rel="noreferrer" target="_blank">github.com</a> <<a href="http://github.com" rel="noreferrer" target="_blank">http://github.com</a>>.<br>
<br>
We do not need an rst file, github handles .txt just fine. I see no<br>
reason to move to txt.<br>
<span class=""><br>
> I'll give that a shot with these patches as a proof of concept:<br>
><br>
> 1. Change cookie-cutter file to CONTRIBUTING.txt<br>
> <a href="https://review.openstack.org/416109" rel="noreferrer" target="_blank">https://review.openstack.org/<wbr>416109</a><br>
> 2. Update openstack-manuals rendered docs with an included<br>
> CONTRIBUTING.txt <a href="https://review.openstack.org/416112" rel="noreferrer" target="_blank">https://review.openstack.org/<wbr>416112</a><br>
><br>
> We won't really know the GitHub UI rendering of the include until<br>
> merged, but I've tested in other repos and changing the file extension<br>
> to .txt gives a link to that file.<br>
<br>
</span>Works with RST as well for me - I just created a pull request for<br>
cookiecutter and got the contributing link as expected. There's no need<br>
to use txt files.<br></blockquote><div><br></div><div>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.</div><div><br></div><div>Anne</div><div> </div><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">
<span class="im HOEnZb"><br>
> Thoughts? Please comment on the reviews or here. I can work on it if we<br>
> think it's worthwhile to standardize upon, and/or collaborate with the<br>
> original contributor who wanted to standardize. I do believe the GitHub<br>
> experience is worthy of attention, similar in my mind to the recent<br>
> badges work.<br>
<br>
</span><span class="im HOEnZb">Andreas<br>
--<br>
 Andreas Jaeger aj@{<a href="http://suse.com" rel="noreferrer" target="_blank">suse.com</a>,<a href="http://opensuse.org" rel="noreferrer" target="_blank">opensuse.org</a>} Twitter: jaegerandi<br>
  SUSE LINUX GmbH, Maxfeldstr. 5, 90409 Nürnberg, Germany<br>
   GF: Felix Imendörffer, Jane Smithard, Graham Norton,<br>
       HRB 21284 (AG Nürnberg)<br>
    GPG fingerprint = 93A3 365E CE47 B889 DF7F  FED1 389A 563C C272 A126<br>
<br>
<br>
</span><div class="HOEnZb"><div class="h5">______________________________<wbr>______________________________<wbr>______________<br>
OpenStack Development Mailing List (not for usage questions)<br>
Unsubscribe: <a href="http://OpenStack-dev-request@lists.openstack.org?subject:unsubscribe" rel="noreferrer" target="_blank">OpenStack-dev-request@lists.<wbr>openstack.org?subject:<wbr>unsubscribe</a><br>
<a href="http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev" rel="noreferrer" target="_blank">http://lists.openstack.org/<wbr>cgi-bin/mailman/listinfo/<wbr>openstack-dev</a><br>
</div></div></blockquote></div><br><br clear="all"><div><br></div>-- <br><div class="gmail_signature" data-smartmail="gmail_signature"><div dir="ltr"><div><div dir="ltr"><div dir="ltr"><div dir="ltr"><div><br></div><div>Read my blog: <a href="https://justwriteclick.com" target="_blank">justwrite.click</a></div><div>Subscribe to Docs|Code: <a href="http://docslikecode.com" target="_blank">docslikecode.com</a> </div></div></div></div></div></div></div>
</div></div>