metron-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Matt Foley (JIRA)" <j...@apache.org>
Subject [jira] [Comment Edited] (METRON-718) integrate versioned site-book to public site (Metron home page)
Date Wed, 08 Mar 2017 20:45:38 GMT

    [ https://issues.apache.org/jira/browse/METRON-718?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15901941#comment-15901941
] 

Matt Foley edited comment on METRON-718 at 3/8/17 8:45 PM:
-----------------------------------------------------------

comments from https://github.com/apache/incubator-metron/pull/459 :

Regarding the integration, what most projects do is, as part of their Site's documentation
area, there is one or more pull-down menus, or a landing page, where you can choose the VERSION
you want of:
* Documentation (site-book, in our case)
* Release Notes
* Javadocs

This implies that the Site needs a cumulative store of past release Doc builds, and that part
of the Release Manager's job is adding each new release to that store. Since it keeps getting
larger and larger, storing it in github master (where Site lives) may not be the best thing.
Rather, it could go under https://dist.apache.org/repos/dist/release/incubator/metron/ (release
-> dev, during votes). The cost of this is a manual step instead of automated, for the
Release Manager.

The Site menu would then link into the many doc sets in the store. Given the regular naming
of the paths, we could actually have each release contain its own doc set (only) at a standard
place, which is consistent with it being part of the build, and then the Site's menu would
have a list of links that differ only by a version number. The RM would make the one-line
edit to add each new doc set as it is released.


was (Author: mattf):
comments from https://github.com/apache/incubator-metron/pull/459 :

Regarding the integration, what most projects do is, as part of their Site's documentation
area, there is one or more pull-down menus, or a landing page, where you can choose the VERSION
you want of:

Documentation (site-book, in our case)
Release Notes
Javadocs
This implies that the Site needs a cumulative store of past release Doc builds, and that part
of the Release Manager's job is adding each new release to that store. Since it keeps getting
larger and larger, storing it in github master (where Site lives) may not be the best thing.
Rather, it could go under https://dist.apache.org/repos/dist/release/incubator/metron/ (release
-> dev, during votes). The cost of this is a manual step instead of automated, for the
Release Manager.

The Site menu would then link into the many doc sets in the store. Given the regular naming
of the paths, we could actually have each release contain its own doc set (only) at a standard
place, which is consistent with it being part of the build, and then the Site's menu would
have a list of links that differ only by a version number. The RM would make the one-line
edit to add each new doc set as it is released.

> integrate versioned site-book to public site (Metron home page)
> ---------------------------------------------------------------
>
>                 Key: METRON-718
>                 URL: https://issues.apache.org/jira/browse/METRON-718
>             Project: Metron
>          Issue Type: Bug
>            Reporter: Matt Foley
>
> Now we have the site-book, with versioned build for each release, we should make it available
from the Metron home page at http://metron.incubator.apache.org/ .  Since the docs area of
our home page currently points at the wiki, this change also relates to METRON-714 .
> Ideally we would accumulate versioned builds for each release, so that users can readily
find the version appropriate to the release they are using.  The versions could be made available
through a gateway page with a table of versions, or a pull-down menu, etc.



--
This message was sent by Atlassian JIRA
(v6.3.15#6346)

Mime
View raw message