Skip to content

RANGER-5354: Docs - add getting started and architecture pages - #1261

Open
kumaab wants to merge 1 commit into
apache:masterfrom
kumaab:ranger-docs-phase2-getting-started-arch
Open

kumaab wants to merge 1 commit into
apache:masterfrom
kumaab:ranger-docs-phase2-getting-started-arch

Conversation

@kumaab

@kumaab kumaab commented Sep 27, 2026

Copy link
Copy Markdown
Contributor

What changes were proposed in this pull request?

RANGER-5354: Phase 2 of migrating Apache Ranger documentation to the MkDocs site (phase 1: #1240).

  • Getting started (7 pages): introduction and key concepts, installation chooser, "Run Ranger with Docker" (released Docker Hub images and dev-support/ranger-docker side by side), "Your first policy" tutorial, FAQ, Trino quick start.
  • Architecture (3 pages): components and data flows, policy model and evaluation order, plugin architecture with the shared plugin configuration as annotated XML.
  • Docker instructions reference only Docker Hub images or dev-support/ranger-docker; the unmaintained root scripts are no longer mentioned. Memory guidance updated: a stack with Hadoop, Hive, Kafka and OpenSearch needs 8 GB.
  • Download page quick start aligned with the Docker Hub description; contributing guide points to dev-support/ranger-docker.
  • CSS: JIRA ids such as RANGER-1234 stay on one line (fixes wrapping in the release-notes tables); Mermaid group boxes are drawn as outlines.
  • Links to pages that arrive in later phases (plugins, services, features, developer guide) are plain text and will be restored once those pages are merged.

How was this patch tested?

  • mkdocs build --strict passes on this branch alone and on the combined site; all Mermaid diagrams parse and were checked rendered.
  • Manually reviewed all architecture related diagrams and a majority of the content in Architecture tab.
  • "Your first policy" was run end to end on a fresh master build with the tutorial's own compose command: all 8 steps match the text, including the exact deny message, policy propagation (~16-20 s) and audit rows.
  • Live preview of the complete target site (this PR plus later phases): https://kumaab.github.io/ranger/ ; for this PR see ONLY tabs Getting Started and Architecture:

Phase 2 of migrating Apache Ranger documentation to the MkDocs site.

- Getting started: introduction, installation, running Ranger with Docker
  (released Docker Hub images and dev-support/ranger-docker side by side),
  first policy tutorial, FAQ, Trino quick start
- Architecture: overview, policy model, plugin architecture (shared plugin
  configuration shown as annotated XML)
- Align the download page quick start with the Docker Hub description and
  point the contributing guide at dev-support/ranger-docker
- CSS: keep JIRA ids such as RANGER-1234 on one line, which also fixes the
  wrapping in the release notes tables; draw Mermaid group boxes as
  outlines so edge labels blend with the page
- Links to pages that arrive in later phases are left as plain text and
  will be restored once those pages are merged

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant