Abhishek Kumar created RANGER-5353:
--------------------------------------
Summary: Documentation Website for Apache Ranger
Key: RANGER-5353
URL: https://issues.apache.org/jira/browse/RANGER-5353
Project: Ranger
Issue Type: Improvement
Components: documentation, Ranger
Reporter: Abhishek Kumar
Assignee: Abhishek Kumar
Currently, Apache Ranger has documentation split across the project website,
wiki, and Javadocs. These resources have grown organically and contain a lot of
valuable detail for users and contributors alike.
However, there’s an opportunity to bring all of this content together in a more
modern, user-friendly format that makes it easier for different
audiences—users, administrators, and developers—to quickly find what they need.
This jira proposes creating a modern documentation site for Apache Ranger using
Material for MkDocs: https://squidfunk.github.io/mkdocs-material/
Material for MkDocs is a modern documentation framework built on MkDocs, a
static site generator for Markdown files. GitHub Repo:
https://github.com/squidfunk/mkdocs-material
This framework provides a clean design, responsive navigation, built-in search,
dark/light modes, versioning support (via mike), and first-class handling of
code snippets and diagrams. Adopting this approach can make Ranger’s
documentation more approachable for new users, while also giving experienced
administrators and developers the depth they need.
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
