You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@mesos.apache.org by Andrew Schwartzmeyer <an...@schwartzmeyer.com> on 2017/10/02 17:12:38 UTC

Re: Refactoring configuration docs

I'm going to assume everyone said "go for it!"

Cheers,

Andrew Schwartzmeyer

On 09/28/2017 9:18 am, Andrew Schwartzmeyer wrote:
> Hi all,
> 
> I'm going through and updating the CMake docs, and that brought me to
> our docs/configuration.md file. This file is huge! In the style of
> Jie's refactor of the isolator docs, I'd like to create a
> docs/configuration folder, and split these files into mesos.md,
> master.md, agent.md, libprocess.md, autotools.md, and cmake.md within
> that folder.
> 
> I think this important for discoverability, especially considering
> that we lack a table of contents. After re-organizing, I would suggest
> that docs/configuration.md become a table of contents with relative
> links into the configuration folder.
> 
> Any objections / ongoing work I might interfere with?
> 
> Thanks,
> 
> Andrew Schwartzmeyer

Re: Refactoring configuration docs

Posted by Timothy Anderegg <ti...@gmail.com>.
+1

On Mon, Oct 2, 2017 at 1:14 PM James Peach <jo...@gmail.com> wrote:

>
> > On Oct 2, 2017, at 10:12 AM, Andrew Schwartzmeyer <
> andrew@schwartzmeyer.com> wrote:
> >
> > I'm going to assume everyone said "go for it!"
>
> Go for it!
>
> >
> > Cheers,
> >
> > Andrew Schwartzmeyer
> >
> > On 09/28/2017 9:18 am, Andrew Schwartzmeyer wrote:
> >> Hi all,
> >> I'm going through and updating the CMake docs, and that brought me to
> >> our docs/configuration.md file. This file is huge! In the style of
> >> Jie's refactor of the isolator docs, I'd like to create a
> >> docs/configuration folder, and split these files into mesos.md,
> >> master.md, agent.md, libprocess.md, autotools.md, and cmake.md within
> >> that folder.
> >> I think this important for discoverability, especially considering
> >> that we lack a table of contents. After re-organizing, I would suggest
> >> that docs/configuration.md become a table of contents with relative
> >> links into the configuration folder.
> >> Any objections / ongoing work I might interfere with?
> >> Thanks,
> >> Andrew Schwartzmeyer
>
>

Re: Refactoring configuration docs

Posted by Vinod Kone <vi...@apache.org>.
+1 Thanks for taking this on!

On Mon, Oct 2, 2017 at 10:14 AM, James Peach <jo...@gmail.com> wrote:

>
> > On Oct 2, 2017, at 10:12 AM, Andrew Schwartzmeyer <
> andrew@schwartzmeyer.com> wrote:
> >
> > I'm going to assume everyone said "go for it!"
>
> Go for it!
>
> >
> > Cheers,
> >
> > Andrew Schwartzmeyer
> >
> > On 09/28/2017 9:18 am, Andrew Schwartzmeyer wrote:
> >> Hi all,
> >> I'm going through and updating the CMake docs, and that brought me to
> >> our docs/configuration.md file. This file is huge! In the style of
> >> Jie's refactor of the isolator docs, I'd like to create a
> >> docs/configuration folder, and split these files into mesos.md,
> >> master.md, agent.md, libprocess.md, autotools.md, and cmake.md within
> >> that folder.
> >> I think this important for discoverability, especially considering
> >> that we lack a table of contents. After re-organizing, I would suggest
> >> that docs/configuration.md become a table of contents with relative
> >> links into the configuration folder.
> >> Any objections / ongoing work I might interfere with?
> >> Thanks,
> >> Andrew Schwartzmeyer
>
>

Re: Refactoring configuration docs

Posted by James Peach <jo...@gmail.com>.
> On Oct 2, 2017, at 10:12 AM, Andrew Schwartzmeyer <an...@schwartzmeyer.com> wrote:
> 
> I'm going to assume everyone said "go for it!"

Go for it!

> 
> Cheers,
> 
> Andrew Schwartzmeyer
> 
> On 09/28/2017 9:18 am, Andrew Schwartzmeyer wrote:
>> Hi all,
>> I'm going through and updating the CMake docs, and that brought me to
>> our docs/configuration.md file. This file is huge! In the style of
>> Jie's refactor of the isolator docs, I'd like to create a
>> docs/configuration folder, and split these files into mesos.md,
>> master.md, agent.md, libprocess.md, autotools.md, and cmake.md within
>> that folder.
>> I think this important for discoverability, especially considering
>> that we lack a table of contents. After re-organizing, I would suggest
>> that docs/configuration.md become a table of contents with relative
>> links into the configuration folder.
>> Any objections / ongoing work I might interfere with?
>> Thanks,
>> Andrew Schwartzmeyer