[
https://issues.apache.org/jira/browse/RATIS-1630?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Riguz Lee updated RATIS-1630:
-----------------------------
Description:
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|[https://maven.apache.org/plugins/maven-site-plugin/index.html|https://maven.apache.org/plugins/maven-site-plugin/index.html),]][,|https://maven.apache.org/plugins/maven-site-plugin/index.html),]
which also supports markdown format, and it does not need the developers to
install anything.
was:
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
[maven-site-plugin]([https://maven.apache.org/plugins/maven-site-plugin/index.html),]
which also supports markdown format, and it does not need the developers to
install anything.
> Improve compatibility of ratis-doc generation for Windows platform
> ------------------------------------------------------------------
>
> Key: RATIS-1630
> URL: https://issues.apache.org/jira/browse/RATIS-1630
> Project: Ratis
> Issue Type: Improvement
> Reporter: Riguz Lee
> Priority: Major
>
> 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|[https://maven.apache.org/plugins/maven-site-plugin/index.html|https://maven.apache.org/plugins/maven-site-plugin/index.html),]][,|https://maven.apache.org/plugins/maven-site-plugin/index.html),]
> 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)
