tree: 2dd085c9fb6a77c543158f1d3e9486637d3e6736 [path history] [tgz]
  1. docs/
  2. mkdocs.yml
  3. README.md
  4. requirements.txt
mkdocs/README.md

Apache Ranger Website and Documentation

Welcome to the official website and documentation for Apache Ranger!

Installation

This documentation site uses MkDocs documentation-focused static site engine, along with Material for MkDocs theme.

Create and activate a new virtual environment:

python3 -m venv .venv

Activate the environment:

source .venv/bin/activate

Install the required dependencies:

pip install -r requirements.txt

Run site locally at http://localhost:8000:

mkdocs serve --strict

To run the site on a different port, such as 8080:

mkdocs serve --strict --dev-addr=127.0.0.1:8080

Build site for production:

mkdocs build

Contributions

We welcome contributions to the Ranger documentation by our community! See Contributing for more information.

To suggest changes, please create a new issue or submit a pull request with the proposed change!