[RATIS-1630] Use maven site plugin instead of Hugo to generate ratis documents for better compatibility

• Type: Improvement
• Status: Resolved
• Priority: Major
• Resolution: Fixed
• Fix Version/s: 2.4.0, 3.0.0
• Component/s: build, documentation
• Assignee: Riguz Lee
• Reporter: Riguz Lee
• Created: 21/Jul/22 01:02
• Updated: 16/Aug/22 16:34
• Resolved: 21/Jul/22 19:29

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 which also supports markdown format, and it does not need the developers to install anything.

Issue Links

• links to: GitHub Pull Request #690