[
https://issues.apache.org/jira/browse/RATIS-1630?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Tsz-wo Sze updated RATIS-1630:
------------------------------
Summary: Use maven site plugin instead of Hugo to generate ratis documents
for better compatibility (was: Improve compatibility of ratis-doc generation
for Windows platform)
> Use maven site plugin instead of Hugo to generate ratis documents for better
> compatibility
> ------------------------------------------------------------------------------------------
>
> Key: RATIS-1630
> URL: https://issues.apache.org/jira/browse/RATIS-1630
> Project: Ratis
> Issue Type: Improvement
> Components: build, documentation
> Reporter: Riguz Lee
> Assignee: Riguz Lee
> Priority: Major
> Fix For: 3.0.0, 2.3.1
>
> Time Spent: 20m
> Remaining Estimate: 0h
>
> The ratis-doc module has been introduced in
> https://issues.apache.org/jira/browse/RATIS-843, which uses hugo as the
> markdown site generation engine. There're a few drawbacks:
> * Developers need to install hugo as a dependency
> * The generation is done by executing a shell script, which is not always
> friendly for developers using Windows
> My suggestion is:
> Replace hugo by using *_apache maven-site-plugin_* which also supports
> markdown format, and it does not need the developers to install anything.
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
