hadoop-common-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Allen Wittenauer (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (HADOOP-14163) Refactor existing hadoop site to use more usable static website generator
Date Wed, 08 Nov 2017 20:46:00 GMT

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

Allen Wittenauer commented on HADOOP-14163:
-------------------------------------------

bq. Hugo is a static website generator, mvn site is for generating project documentation.


mvn site is also effectively a static website generator.  So that's pretty much a wash. There
are some big wins I don't see with hugo:

a) maven is already part of our build process and already very familiar to pretty much the
entire community
b) maven is cross platform and available on MANY OSes/chipsets without having to compile it
yourself to get there
c) maven is already part of our CI pipeline... 

bq. to simplify the release process

Sure, everything is simpler if it doesn't have any sort of testing phase.  A mvn site-based
install means we can actually use precommit to apply patches for testing.

bq. With hugo it's very simple and easy to automatize thx to the flexible content handling
and dynamic menu generation. 

To me, this seems like greatly overestimating the need and underestimating the existing toolset.
 The main website rarely gets updated.  Using a different build and content management system
won't help in that regard either.

Also, just to clarify "How does this integrate with the docs from a release?"... I'm looking
for "release manager takes the site tar ball and does X with it."  Right now, none of that
seems to be covered.

bq. I think only the docs/downloads are using external links which are fine

I think this might be a point of confusion.  The downloads are external.  But http://hadoop.apache.org/docs/
is supposed to be coming off this website.  Updating that needs to be part of this patch/documentation
for this process.

Also, let me clarify the question a bit.  If I build the website in hugo and then browse the
public filesystem with a browser, things fail to load and links are broken.  That's less than
ideal.

> Refactor existing hadoop site to use more usable static website generator
> -------------------------------------------------------------------------
>
>                 Key: HADOOP-14163
>                 URL: https://issues.apache.org/jira/browse/HADOOP-14163
>             Project: Hadoop Common
>          Issue Type: Improvement
>          Components: site
>            Reporter: Elek, Marton
>            Assignee: Elek, Marton
>         Attachments: HADOOP-14163-001.zip, HADOOP-14163-002.zip, HADOOP-14163-003.zip,
HADOOP-14163.004.patch, HADOOP-14163.005.patch, HADOOP-14163.006.patch, HADOOP-14163.007.patch,
HADOOP-14163.008.tar.gz, hadoop-site.tar.gz, hadop-site-rendered.tar.gz
>
>
> From the dev mailing list:
> "Publishing can be attacked via a mix of scripting and revamping the darned website.
Forrest is pretty bad compared to the newer static site generators out there (e.g. need to
write XML instead of markdown, it's hard to review a staging site because of all the absolute
links, hard to customize, did I mention XML?), and the look and feel of the site is from the
00s. We don't actually have that much site content, so it should be possible to migrate to
a new system."
> This issue is find a solution to migrate the old site to a new modern static site generator
using a more contemprary theme.
> Goals: 
>  * existing links should work (or at least redirected)
>  * It should be easy to add more content required by a release automatically (most probably
with creating separated markdown files)



--
This message was sent by Atlassian JIRA
(v6.4.14#64029)

---------------------------------------------------------------------
To unsubscribe, e-mail: common-issues-unsubscribe@hadoop.apache.org
For additional commands, e-mail: common-issues-help@hadoop.apache.org


Mime
View raw message