[Gluster-devel] Branching out Gluster docs

Prashanth Pai ppai at redhat.com
Mon Mar 19 03:36:19 UTC 2018


Sounds good to me.

RTD does support generating docs from multiple git branches out of the box.

On Sat, Mar 17, 2018 at 7:53 PM, Humble Devassy Chirammal <
humble.devassy at gmail.com> wrote:

> Hi Nigel,
>
> I am fine with  branching out current master to a new branch and keep
> master with 4.x series as long as the urls are properly redirected or
> doesnt give 404. That said, gluster documentation is referred from various
> sources and we should not break it.
>
> Regarding version banner, I am more than 100% happy to have it.
>
>
> --Humble
>
>
> On Sat, Mar 17, 2018 at 7:29 PM, Nigel Babu <nigelb at redhat.com> wrote:
>
>> Hello folks,
>>
>> Our docs need a significant facelift. Nithya has suggested that we branch
>> out the current docs into a branch called version-3 (or some such, please
>> let's not bikeshed about the name) and have the master branch track 4.x
>> series. We will significantly change the documentation for master branch so
>> that it has a better content flow as well as give correct instructions for
>> working with GD2.
>>
>> Among other things, we'll have to add a banner to the docs that
>> highlights which version you're looking at. This is not a problem, I can
>> handle that.
>>
>> Humble and Prashant, do you both agree this is a good idea? I'm happy to
>> do all the work needed to make this happen.
>>
>> --
>> nigelb
>>
>> _______________________________________________
>> Gluster-devel mailing list
>> Gluster-devel at gluster.org
>> http://lists.gluster.org/mailman/listinfo/gluster-devel
>>
>
>
> _______________________________________________
> Gluster-devel mailing list
> Gluster-devel at gluster.org
> http://lists.gluster.org/mailman/listinfo/gluster-devel
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.gluster.org/pipermail/gluster-devel/attachments/20180319/7a573efb/attachment.html>


More information about the Gluster-devel mailing list