<div dir="ltr"><br><div class="gmail_extra"><br><div class="gmail_quote">On Sat, Aug 13, 2016 at 12:23 AM, Niels de Vos <span dir="ltr"><<a href="mailto:ndevos@redhat.com" target="_blank">ndevos@redhat.com</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"><div class="HOEnZb"><div class="h5">On Thu, Aug 11, 2016 at 01:23:43PM -0700, Amye Scavarda wrote:<br>
> The Red Hat Gluster Storage documentation team and I had a conversation<br>
> about how we can our upstream documentation more consistent and improved<br>
> for our users, and they're willing to work with us to find where the major<br>
> gaps are in our documentation. This is awesome! But it's going to take some<br>
> work on our side to make this a reality.<br>
><br>
> One piece that's come up is that we should probably look towards changing<br>
> current tooling for this. It turns out that our ReadTheDocs instance search<br>
> is failing because we're using markdown, and this is a known issue. It<br>
> doesn't look like it's going to be fixed anytime soon.<br>
><br>
> Rather than continue to try to make RTD serve our needs, I'd like to<br>
> propose the following changes to where our documentation lives and in what<br>
> language:<br>
> I'd much rather pattern after <a href="http://docs.openshift.org" rel="noreferrer" target="_blank">docs.openshift.org</a>, move to ASCIIdoc and use<br>
> ASCIIbinder as our engine to power this. What that does is give us control<br>
> over our overall infrastructure underneath our documentation, maintain our<br>
> existing git workflow for adding to documentation, and matches with other<br>
> communities that we work closely with. I'm mindful that there's a burden of<br>
> migration again, but we'll be able to resolve a lot of the challenges we<br>
> have with documentation currently: more control over layout, ability to<br>
> change the structure to make it more user friendly, use our own search<br>
> however we see fit.<br>
><br>
> I'm happy to take comments on this proposal. Over the next week, I'll be<br>
> reviewing the level of effort it would take to migrate to ASCIIdocs and<br>
> ASCIIbinder, with the goal being to have this in place by end of September.<br>
<br>
</div></div>Sounds like a plan to me. I'm not sure how much you have discussed this<br>
with the current doc maintainers, I think there is some restructuring of<br>
the contents going on as well. It would be a shame if that is lost in<br>
the process.<br>
<br></blockquote><div>Adding Humble and Prasanth here I as I'm not sure what this restructuring movement is? </div><div><br></div><div><br></div><div>Thanks!</div><div>- amye </div><div> </div><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">
Could you (or one of the other doc maintainers) give a talk/demo at the<br>
Gluster Summit about the process of contributing to the documentation? I<br>
have the feeling only very few people are aware how to send<br>
documentation changes.<br>
<br>
Thanks,<br>
Niels<br>
</blockquote></div><br><br clear="all"><div><br></div>-- <br><div class="gmail_signature" data-smartmail="gmail_signature"><div dir="ltr">Amye Scavarda | <a href="mailto:amye@redhat.com" target="_blank">amye@redhat.com</a> | Gluster Community Lead</div></div>
</div></div>