You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@mesos.apache.org by Benjamin Mahler <bm...@apache.org> on 2016/07/01 01:24:21 UTC
Re: Two important tickets for improving documentation
Looks like Vinod will shepherd, thanks Vinod!
On Tue, Jun 28, 2016 at 4:38 PM, Timothy Anderegg <
timothy.anderegg@gmail.com> wrote:
> I picked it up as part of the website working group, but don't have a
> shepherd yet.
>
> On Tue, Jun 28, 2016, 7:06 PM Benjamin Mahler <bm...@apache.org> wrote:
>
> > Thanks a lot Timothy!
> >
> > Do you have a shepherd or do you still need one?
> >
> > On Tue, Jun 28, 2016 at 7:19 AM, Timothy Anderegg <
> > timothy.anderegg@gmail.com> wrote:
> >
> > > Hi Ben - I'm actually almost done with Mesos-3011, will open a review
> > > request in the next few days. Only a few last issues to resolve.
> > >
> > > On Mon, Jun 27, 2016, 11:20 PM Benjamin Mahler <bm...@apache.org>
> > wrote:
> > >
> > > > Just wanted to highlight two tickets that would be of great help to
> the
> > > > community.
> > > >
> > > > (1) The first is to publish documentation on the website for each
> > > release.
> > > > We currently publish periodically off of master, and so it's a pain
> for
> > > > users because the documentation does not reflect the version they are
> > > > running:
> > > >
> > > > https://issues.apache.org/jira/browse/MESOS-3011
> > > >
> > > > Once we have the tooling we can publish the documentation for
> previous
> > > > releases.
> > > >
> > > > (2) The second is to automate the generation of docs/
> configuration.md.
> > > As
> > > > far as I know, we're still generating this manually, which makes it a
> > > huge
> > > > pain and consequently it becomes stale:
> > > >
> > > > https://issues.apache.org/jira/browse/MESOS-3019
> > > >
> > > > This would be done in a similar way to how Kevin Klues added a
> support
> > > > script for generating the help endpoint documentation.
> > > >
> > > > Vinod, looks like we need to do an update of configuration.md for
> 1.0?
> > > >
> > > > Ben
> > > >
> > >
> >
>
Re: Two important tickets for improving documentation
Posted by Timothy Anderegg <ti...@gmail.com>.
So a few days turned into a few months, but Mesos-3011 (versioned
documentation on the website) is ready for review if anyone has time,
thanks! https://issues.apache.org/jira/browse/MESOS-3011
-Tim
On Thu, Jun 30, 2016 at 9:43 PM Timothy Anderegg <ti...@gmail.com>
wrote:
> Yep, thanks Vinod!
>
> On Thu, Jun 30, 2016, 9:24 PM Benjamin Mahler <bm...@apache.org> wrote:
>
>> Looks like Vinod will shepherd, thanks Vinod!
>>
>> On Tue, Jun 28, 2016 at 4:38 PM, Timothy Anderegg <
>> timothy.anderegg@gmail.com> wrote:
>>
>> > I picked it up as part of the website working group, but don't have a
>> > shepherd yet.
>> >
>> > On Tue, Jun 28, 2016, 7:06 PM Benjamin Mahler <bm...@apache.org>
>> wrote:
>> >
>> > > Thanks a lot Timothy!
>> > >
>> > > Do you have a shepherd or do you still need one?
>> > >
>> > > On Tue, Jun 28, 2016 at 7:19 AM, Timothy Anderegg <
>> > > timothy.anderegg@gmail.com> wrote:
>> > >
>> > > > Hi Ben - I'm actually almost done with Mesos-3011, will open a
>> review
>> > > > request in the next few days. Only a few last issues to resolve.
>> > > >
>> > > > On Mon, Jun 27, 2016, 11:20 PM Benjamin Mahler <bm...@apache.org>
>> > > wrote:
>> > > >
>> > > > > Just wanted to highlight two tickets that would be of great help
>> to
>> > the
>> > > > > community.
>> > > > >
>> > > > > (1) The first is to publish documentation on the website for each
>> > > > release.
>> > > > > We currently publish periodically off of master, and so it's a
>> pain
>> > for
>> > > > > users because the documentation does not reflect the version they
>> are
>> > > > > running:
>> > > > >
>> > > > > https://issues.apache.org/jira/browse/MESOS-3011
>> > > > >
>> > > > > Once we have the tooling we can publish the documentation for
>> > previous
>> > > > > releases.
>> > > > >
>> > > > > (2) The second is to automate the generation of docs/
>> > configuration.md.
>> > > > As
>> > > > > far as I know, we're still generating this manually, which makes
>> it a
>> > > > huge
>> > > > > pain and consequently it becomes stale:
>> > > > >
>> > > > > https://issues.apache.org/jira/browse/MESOS-3019
>> > > > >
>> > > > > This would be done in a similar way to how Kevin Klues added a
>> > support
>> > > > > script for generating the help endpoint documentation.
>> > > > >
>> > > > > Vinod, looks like we need to do an update of configuration.md for
>> > 1.0?
>> > > > >
>> > > > > Ben
>> > > > >
>> > > >
>> > >
>> >
>>
>
Re: Two important tickets for improving documentation
Posted by Timothy Anderegg <ti...@gmail.com>.
Yep, thanks Vinod!
On Thu, Jun 30, 2016, 9:24 PM Benjamin Mahler <bm...@apache.org> wrote:
> Looks like Vinod will shepherd, thanks Vinod!
>
> On Tue, Jun 28, 2016 at 4:38 PM, Timothy Anderegg <
> timothy.anderegg@gmail.com> wrote:
>
> > I picked it up as part of the website working group, but don't have a
> > shepherd yet.
> >
> > On Tue, Jun 28, 2016, 7:06 PM Benjamin Mahler <bm...@apache.org>
> wrote:
> >
> > > Thanks a lot Timothy!
> > >
> > > Do you have a shepherd or do you still need one?
> > >
> > > On Tue, Jun 28, 2016 at 7:19 AM, Timothy Anderegg <
> > > timothy.anderegg@gmail.com> wrote:
> > >
> > > > Hi Ben - I'm actually almost done with Mesos-3011, will open a review
> > > > request in the next few days. Only a few last issues to resolve.
> > > >
> > > > On Mon, Jun 27, 2016, 11:20 PM Benjamin Mahler <bm...@apache.org>
> > > wrote:
> > > >
> > > > > Just wanted to highlight two tickets that would be of great help to
> > the
> > > > > community.
> > > > >
> > > > > (1) The first is to publish documentation on the website for each
> > > > release.
> > > > > We currently publish periodically off of master, and so it's a pain
> > for
> > > > > users because the documentation does not reflect the version they
> are
> > > > > running:
> > > > >
> > > > > https://issues.apache.org/jira/browse/MESOS-3011
> > > > >
> > > > > Once we have the tooling we can publish the documentation for
> > previous
> > > > > releases.
> > > > >
> > > > > (2) The second is to automate the generation of docs/
> > configuration.md.
> > > > As
> > > > > far as I know, we're still generating this manually, which makes
> it a
> > > > huge
> > > > > pain and consequently it becomes stale:
> > > > >
> > > > > https://issues.apache.org/jira/browse/MESOS-3019
> > > > >
> > > > > This would be done in a similar way to how Kevin Klues added a
> > support
> > > > > script for generating the help endpoint documentation.
> > > > >
> > > > > Vinod, looks like we need to do an update of configuration.md for
> > 1.0?
> > > > >
> > > > > Ben
> > > > >
> > > >
> > >
> >
>