metron-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Zeolla@GMail.com" <zeo...@gmail.com>
Subject Re: [DISCUSS] Update Metron Release Documentation
Date Mon, 01 May 2017 14:06:54 GMT
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 <cestella@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 <cestella@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

Mime
  • Unnamed multipart/alternative (inline, None, 0 bytes)
View raw message