You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@metron.apache.org by "Zeolla@GMail.com" <ze...@gmail.com> on 2017/05/01 14:06:54 UTC
Re: [DISCUSS] Update Metron Release Documentation
Just bringing up this thread again, as we're going to have two books as of
the 0.4.0 release. I don't have any strong opinions on the topic
Jon
On Wed, Feb 15, 2017 at 10:13 AM Casey Stella <ce...@gmail.com> wrote:
> On the subject, we should also document updating the releases page after a
> release and figure out how old books are stored/served up. Anyone have
> thoughts on that?
>
> On Wed, Feb 15, 2017 at 9:53 AM, Casey Stella <ce...@gmail.com> wrote:
>
> > Yeah I agree we need to document it there.
> >
> > On Tue, Feb 14, 2017 at 09:57 Zeolla@GMail.com <ze...@gmail.com> wrote:
> >
> >> As a follow-up to METRON-716, I would like to suggest that we update our
> >> Metron
> >> Release documentation
> >> <https://cwiki.apache.org/confluence/display/METRON/Release+Process> to
> >> account for the site-book. Specifically, I think that Step 4 and Step 9
> >> need a bit of a refresher.
> >>
> >> In the most recent build, Casey appears to have handled this by building
> >> the site-book and then releasing it to
> >> https://dist.apache.org/repos/dist/dev/incubator/metron/0.3.
> >> 1-RC4-incubating/book-site,
> >> documenting that in the VOTE thread.
> >>
> >> My initial question is, is there a reason to use the "book-site" folder
> >> name, as opposed to "site-book"? I would prefer to pick a standard and
> >> stick with it, if possible.
> >>
> >> Regardless, I am suggesting that under Step 4 we add the following
> bullet
> >> under the "The artifacts for a release" section:
> >>
> >> "- The site-book documentation, as generated using the most recent
> >> documentation under the site-book/README.md."
> >>
> >> And under Step 9 we add the following:
> >>
> >> "- Update the Metron site documentation links to point to the
> >> documentation
> >> for the most recent release."
> >>
> >> Right now the website points to the wiki
> >> <https://cwiki.apache.org/confluence/display/METRON/Documentation>.
> >> Thoughts?
> >>
> >> Jon
> >> --
> >>
> >> Jon
> >>
> >> Sent from my mobile device
> >>
> >
>
--
Jon
Re: [DISCUSS] Update Metron Release Documentation
Posted by Matt Foley <ma...@apache.org>.
It would be nice if someone more familiar with javascript than I added this functionality to the site.
Thanks,
--Matt
On 5/5/17, 8:11 AM, "Zeolla@GMail.com" <ze...@gmail.com> wrote:
So I'm not hearing any opposition to the idea. What do we need to handle
for the eventual 0.4.0 release? I really only see a need to update the
release documentation to account for this. Thanks,
Jon
On Mon, May 1, 2017 at 2:39 PM Matt Foley <ma...@apache.org> wrote:
> In previous discussion threads, I proposed that the site should have a
> pull-down menu for all existing docs versions, so user could choose which
> one they want to access. Each choice would point into the release repo.
> This implies the Release Manager has to make a one-line edit to add each
> new release’s book to the pull-down.
>
> Better, we can do what many projects do and have a docs area under the
> release repo, separate from the code area. The menu in question can then
> be automatically constructed from the available set of choices. Not a bad
> thing to make older versions of the code accessible similarly.
>
> --Matt
>
> On 5/1/17, 9:20 AM, "Nick Allen" <ni...@nickallen.org> wrote:
>
> One major benefit of the site-book is that we can maintain docs for
> previous releases of Metron. Unless there is a major technical hurdle,
> I
> think we should do so.
>
> On Mon, May 1, 2017 at 10:06 AM, Zeolla@GMail.com <ze...@gmail.com>
> wrote:
>
> > Just bringing up this thread again, as we're going to have two books
> as of
> > the 0.4.0 release. I don't have any strong opinions on the topic
> >
> > Jon
> >
> > On Wed, Feb 15, 2017 at 10:13 AM Casey Stella <ce...@gmail.com>
> wrote:
> >
> > > On the subject, we should also document updating the releases page
> after
> > a
> > > release and figure out how old books are stored/served up. Anyone
> have
> > > thoughts on that?
> > >
> > > On Wed, Feb 15, 2017 at 9:53 AM, Casey Stella <ce...@gmail.com>
> > wrote:
> > >
> > > > Yeah I agree we need to document it there.
> > > >
> > > > On Tue, Feb 14, 2017 at 09:57 Zeolla@GMail.com <zeolla@gmail.com
> >
> > wrote:
> > > >
> > > >> As a follow-up to METRON-716, I would like to suggest that we
> update
> > our
> > > >> Metron
> > > >> Release documentation
> > > >> <
> https://cwiki.apache.org/confluence/display/METRON/Release+Process>
> > to
> > > >> account for the site-book. Specifically, I think that Step 4
> and
> > Step 9
> > > >> need a bit of a refresher.
> > > >>
> > > >> In the most recent build, Casey appears to have handled this by
> > building
> > > >> the site-book and then releasing it to
> > > >> https://dist.apache.org/repos/dist/dev/incubator/metron/0.3.
> > > >> 1-RC4-incubating/book-site,
> > > >> documenting that in the VOTE thread.
> > > >>
> > > >> My initial question is, is there a reason to use the "book-site"
> > folder
> > > >> name, as opposed to "site-book"? I would prefer to pick a
> standard
> > and
> > > >> stick with it, if possible.
> > > >>
> > > >> Regardless, I am suggesting that under Step 4 we add the
> following
> > > bullet
> > > >> under the "The artifacts for a release" section:
> > > >>
> > > >> "- The site-book documentation, as generated using the most
> recent
> > > >> documentation under the site-book/README.md."
> > > >>
> > > >> And under Step 9 we add the following:
> > > >>
> > > >> "- Update the Metron site documentation links to point to the
> > > >> documentation
> > > >> for the most recent release."
> > > >>
> > > >> Right now the website points to the wiki
> > > >> <
> https://cwiki.apache.org/confluence/display/METRON/Documentation>.
> > > >> Thoughts?
> > > >>
> > > >> Jon
> > > >> --
> > > >>
> > > >> Jon
> > > >>
> > > >> Sent from my mobile device
> > > >>
> > > >
> > >
> > --
> >
> > Jon
> >
>
>
>
> --
Jon
Re: [DISCUSS] Update Metron Release Documentation
Posted by "Zeolla@GMail.com" <ze...@gmail.com>.
So I'm not hearing any opposition to the idea. What do we need to handle
for the eventual 0.4.0 release? I really only see a need to update the
release documentation to account for this. Thanks,
Jon
On Mon, May 1, 2017 at 2:39 PM Matt Foley <ma...@apache.org> wrote:
> In previous discussion threads, I proposed that the site should have a
> pull-down menu for all existing docs versions, so user could choose which
> one they want to access. Each choice would point into the release repo.
> This implies the Release Manager has to make a one-line edit to add each
> new release’s book to the pull-down.
>
> Better, we can do what many projects do and have a docs area under the
> release repo, separate from the code area. The menu in question can then
> be automatically constructed from the available set of choices. Not a bad
> thing to make older versions of the code accessible similarly.
>
> --Matt
>
> On 5/1/17, 9:20 AM, "Nick Allen" <ni...@nickallen.org> wrote:
>
> One major benefit of the site-book is that we can maintain docs for
> previous releases of Metron. Unless there is a major technical hurdle,
> I
> think we should do so.
>
> On Mon, May 1, 2017 at 10:06 AM, Zeolla@GMail.com <ze...@gmail.com>
> wrote:
>
> > Just bringing up this thread again, as we're going to have two books
> as of
> > the 0.4.0 release. I don't have any strong opinions on the topic
> >
> > Jon
> >
> > On Wed, Feb 15, 2017 at 10:13 AM Casey Stella <ce...@gmail.com>
> wrote:
> >
> > > On the subject, we should also document updating the releases page
> after
> > a
> > > release and figure out how old books are stored/served up. Anyone
> have
> > > thoughts on that?
> > >
> > > On Wed, Feb 15, 2017 at 9:53 AM, Casey Stella <ce...@gmail.com>
> > wrote:
> > >
> > > > Yeah I agree we need to document it there.
> > > >
> > > > On Tue, Feb 14, 2017 at 09:57 Zeolla@GMail.com <zeolla@gmail.com
> >
> > wrote:
> > > >
> > > >> As a follow-up to METRON-716, I would like to suggest that we
> update
> > our
> > > >> Metron
> > > >> Release documentation
> > > >> <
> https://cwiki.apache.org/confluence/display/METRON/Release+Process>
> > to
> > > >> account for the site-book. Specifically, I think that Step 4
> and
> > Step 9
> > > >> need a bit of a refresher.
> > > >>
> > > >> In the most recent build, Casey appears to have handled this by
> > building
> > > >> the site-book and then releasing it to
> > > >> https://dist.apache.org/repos/dist/dev/incubator/metron/0.3.
> > > >> 1-RC4-incubating/book-site,
> > > >> documenting that in the VOTE thread.
> > > >>
> > > >> My initial question is, is there a reason to use the "book-site"
> > folder
> > > >> name, as opposed to "site-book"? I would prefer to pick a
> standard
> > and
> > > >> stick with it, if possible.
> > > >>
> > > >> Regardless, I am suggesting that under Step 4 we add the
> following
> > > bullet
> > > >> under the "The artifacts for a release" section:
> > > >>
> > > >> "- The site-book documentation, as generated using the most
> recent
> > > >> documentation under the site-book/README.md."
> > > >>
> > > >> And under Step 9 we add the following:
> > > >>
> > > >> "- Update the Metron site documentation links to point to the
> > > >> documentation
> > > >> for the most recent release."
> > > >>
> > > >> Right now the website points to the wiki
> > > >> <
> https://cwiki.apache.org/confluence/display/METRON/Documentation>.
> > > >> Thoughts?
> > > >>
> > > >> Jon
> > > >> --
> > > >>
> > > >> Jon
> > > >>
> > > >> Sent from my mobile device
> > > >>
> > > >
> > >
> > --
> >
> > Jon
> >
>
>
>
> --
Jon
Re: [DISCUSS] Update Metron Release Documentation
Posted by Matt Foley <ma...@apache.org>.
In previous discussion threads, I proposed that the site should have a pull-down menu for all existing docs versions, so user could choose which one they want to access. Each choice would point into the release repo. This implies the Release Manager has to make a one-line edit to add each new release’s book to the pull-down.
Better, we can do what many projects do and have a docs area under the release repo, separate from the code area. The menu in question can then be automatically constructed from the available set of choices. Not a bad thing to make older versions of the code accessible similarly.
--Matt
On 5/1/17, 9:20 AM, "Nick Allen" <ni...@nickallen.org> wrote:
One major benefit of the site-book is that we can maintain docs for
previous releases of Metron. Unless there is a major technical hurdle, I
think we should do so.
On Mon, May 1, 2017 at 10:06 AM, Zeolla@GMail.com <ze...@gmail.com> wrote:
> Just bringing up this thread again, as we're going to have two books as of
> the 0.4.0 release. I don't have any strong opinions on the topic
>
> Jon
>
> On Wed, Feb 15, 2017 at 10:13 AM Casey Stella <ce...@gmail.com> wrote:
>
> > On the subject, we should also document updating the releases page after
> a
> > release and figure out how old books are stored/served up. Anyone have
> > thoughts on that?
> >
> > On Wed, Feb 15, 2017 at 9:53 AM, Casey Stella <ce...@gmail.com>
> wrote:
> >
> > > Yeah I agree we need to document it there.
> > >
> > > On Tue, Feb 14, 2017 at 09:57 Zeolla@GMail.com <ze...@gmail.com>
> wrote:
> > >
> > >> As a follow-up to METRON-716, I would like to suggest that we update
> our
> > >> Metron
> > >> Release documentation
> > >> <https://cwiki.apache.org/confluence/display/METRON/Release+Process>
> to
> > >> account for the site-book. Specifically, I think that Step 4 and
> Step 9
> > >> need a bit of a refresher.
> > >>
> > >> In the most recent build, Casey appears to have handled this by
> building
> > >> the site-book and then releasing it to
> > >> https://dist.apache.org/repos/dist/dev/incubator/metron/0.3.
> > >> 1-RC4-incubating/book-site,
> > >> documenting that in the VOTE thread.
> > >>
> > >> My initial question is, is there a reason to use the "book-site"
> folder
> > >> name, as opposed to "site-book"? I would prefer to pick a standard
> and
> > >> stick with it, if possible.
> > >>
> > >> Regardless, I am suggesting that under Step 4 we add the following
> > bullet
> > >> under the "The artifacts for a release" section:
> > >>
> > >> "- The site-book documentation, as generated using the most recent
> > >> documentation under the site-book/README.md."
> > >>
> > >> And under Step 9 we add the following:
> > >>
> > >> "- Update the Metron site documentation links to point to the
> > >> documentation
> > >> for the most recent release."
> > >>
> > >> Right now the website points to the wiki
> > >> <https://cwiki.apache.org/confluence/display/METRON/Documentation>.
> > >> Thoughts?
> > >>
> > >> Jon
> > >> --
> > >>
> > >> Jon
> > >>
> > >> Sent from my mobile device
> > >>
> > >
> >
> --
>
> Jon
>
Re: [DISCUSS] Update Metron Release Documentation
Posted by Nick Allen <ni...@nickallen.org>.
One major benefit of the site-book is that we can maintain docs for
previous releases of Metron. Unless there is a major technical hurdle, I
think we should do so.
On Mon, May 1, 2017 at 10:06 AM, Zeolla@GMail.com <ze...@gmail.com> wrote:
> Just bringing up this thread again, as we're going to have two books as of
> the 0.4.0 release. I don't have any strong opinions on the topic
>
> Jon
>
> On Wed, Feb 15, 2017 at 10:13 AM Casey Stella <ce...@gmail.com> wrote:
>
> > On the subject, we should also document updating the releases page after
> a
> > release and figure out how old books are stored/served up. Anyone have
> > thoughts on that?
> >
> > On Wed, Feb 15, 2017 at 9:53 AM, Casey Stella <ce...@gmail.com>
> wrote:
> >
> > > Yeah I agree we need to document it there.
> > >
> > > On Tue, Feb 14, 2017 at 09:57 Zeolla@GMail.com <ze...@gmail.com>
> wrote:
> > >
> > >> As a follow-up to METRON-716, I would like to suggest that we update
> our
> > >> Metron
> > >> Release documentation
> > >> <https://cwiki.apache.org/confluence/display/METRON/Release+Process>
> to
> > >> account for the site-book. Specifically, I think that Step 4 and
> Step 9
> > >> need a bit of a refresher.
> > >>
> > >> In the most recent build, Casey appears to have handled this by
> building
> > >> the site-book and then releasing it to
> > >> https://dist.apache.org/repos/dist/dev/incubator/metron/0.3.
> > >> 1-RC4-incubating/book-site,
> > >> documenting that in the VOTE thread.
> > >>
> > >> My initial question is, is there a reason to use the "book-site"
> folder
> > >> name, as opposed to "site-book"? I would prefer to pick a standard
> and
> > >> stick with it, if possible.
> > >>
> > >> Regardless, I am suggesting that under Step 4 we add the following
> > bullet
> > >> under the "The artifacts for a release" section:
> > >>
> > >> "- The site-book documentation, as generated using the most recent
> > >> documentation under the site-book/README.md."
> > >>
> > >> And under Step 9 we add the following:
> > >>
> > >> "- Update the Metron site documentation links to point to the
> > >> documentation
> > >> for the most recent release."
> > >>
> > >> Right now the website points to the wiki
> > >> <https://cwiki.apache.org/confluence/display/METRON/Documentation>.
> > >> Thoughts?
> > >>
> > >> Jon
> > >> --
> > >>
> > >> Jon
> > >>
> > >> Sent from my mobile device
> > >>
> > >
> >
> --
>
> Jon
>