[jira] [Commented] (HADOOP-14163) Refactor existing hadoop site to use more usable static website generator

["Elek, Marton (JIRA)" <ji...@apache.org>]

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

Elek, Marton commented on HADOOP-14163:
---------------------------------------

Hi, let's continue the discussion forward to a new hadoop site. 

I agree with you in many point. Let me summarize

Maven site:

 * PRO: Doesn't require external tool
 * PRO: yetus supports it out of the box
 * CON: more limited capabilities to do a modern site: only one good theme, no support for different content type.
 
Hugo site:
 * PRO: Single binary, runs everywhere 
 * CON: But requires one additional download
 * PRO: Easy to use, mainstream, well supported, many available themes, active development
 * PRO: Supports automatic content generation (release announcement could be generated during the releaseing process)
 * PRO: Supports sitemap/rss everything what a proper site needs

Forrest (existing solution)
 * CON: Hard to generate new content for every release
 * CON: Not so easy to use
 * CON: No modern responsive look and feel

I think this is the same what you said. The only differences between our views that I think the CON of hugo (we need one external tool) is negligible compared to the advantages (much more powerfull for site generation. See the proposed example).

First of all I would like to clarify: I propose to replace the forrest based site generation and NOT the /docs generation. I agree with you that maven site plugin is good for generating version specific documentation. I think the site could be generated with hugo and the docs could be generated as before. WIth both generation the results should be copied to the svn branch (which could be moved to git).

(And just answer the question: locally it could be tested with "hugo serve" command and checking the rendered version at http://localhost:1313/ It also provides a much easier development experience than the maven site generation)

What do you think? Could you accept the proposed version with further enhancement? We can create followup jira to check the site generation with yetus. What else do we need?

Thank you very much to take the time and review it.

> 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