metron-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From mattf-horton <...@git.apache.org>
Subject [GitHub] incubator-metron issue #459: METRON-726: Clean up mvn site generation
Date Wed, 08 Mar 2017 20:28:31 GMT
Github user mattf-horton commented on the issue:

    https://github.com/apache/incubator-metron/pull/459
  
    @justinleet , +100 that you've added site-book and javadocs to the automated build.
    Having site-book in the base build is fine, it only takes seconds to build, and it will
keep new README.md files clean.  Javadoc takes a little longer, I think, but is also important
to keep clean.  Is there something like "-DskipSite" that prevents all three (site, site-book,
and javadocs) from being built, if a developer wants to skip them?
    
    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.
    
    What do you think?



---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

Mime
View raw message