This is an automated email from the ASF dual-hosted git repository.
abhi pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/ranger.git
The following commit(s) were added to refs/heads/master by this push:
new 10f5d07b7 RANGER-5353: Introduce Material for Mkdocs for Apache Ranger
Docs (#793)
10f5d07b7 is described below
commit 10f5d07b745e6118363a4c48f88bed0dc4458477
Author: Abhishek Kumar <[email protected]>
AuthorDate: Tue Jan 13 13:08:42 2026 -0800
RANGER-5353: Introduce Material for Mkdocs for Apache Ranger Docs (#793)
---
.github/workflows/docs.yml | 73 +++++++++++
mkdocs/README.md | 60 +++++++++
mkdocs/docs/arch/architecture.md | 18 +++
mkdocs/docs/assets/brand/Satoshi-Variable.ttf | Bin 0 -> 127420 bytes
mkdocs/docs/assets/brand/favicon.ico | Bin 0 -> 15406 bytes
mkdocs/docs/assets/brand/merged-logo.svg | 50 +++++++
mkdocs/docs/assets/brand/ranger-logo.svg | 17 +++
mkdocs/docs/assets/css/custom.css | 102 +++++++++++++++
mkdocs/docs/assets/css/search-bar.css | 91 +++++++++++++
mkdocs/docs/assets/css/table.css | 30 +++++
mkdocs/docs/assets/js/typewriter.js | 35 +++++
mkdocs/docs/blog/blog.md | 18 +++
mkdocs/docs/features/client-interface/intro.md | 29 +++++
mkdocs/docs/features/gds/gds_intro.md | 18 +++
mkdocs/docs/features/sec-zone/intro.md | 18 +++
mkdocs/docs/getting-started/install.md | 22 ++++
mkdocs/docs/getting-started/trino-with-ranger.md | 24 ++++
mkdocs/docs/index.md | 35 +++++
mkdocs/docs/overrides/home.html | 135 +++++++++++++++++++
mkdocs/docs/plugins/trino.md | 18 +++
mkdocs/docs/project/asf-index.md | 25 ++++
mkdocs/docs/project/contributing.md | 21 +++
mkdocs/docs/project/cve-list.md | 22 ++++
mkdocs/docs/project/java-code-style.md | 21 +++
mkdocs/docs/project/release-process.md | 18 +++
mkdocs/docs/release-notes/index.md | 20 +++
mkdocs/docs/services/admin/service.md | 18 +++
mkdocs/docs/services/kms/service.md | 18 +++
mkdocs/docs/services/tagsync/service.md | 18 +++
mkdocs/docs/services/usersync/service.md | 18 +++
mkdocs/mkdocs.yml | 158 +++++++++++++++++++++++
mkdocs/requirements.txt | 6 +
pom.xml | 2 +
33 files changed, 1158 insertions(+)
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
new file mode 100644
index 000000000..9a7282765
--- /dev/null
+++ b/.github/workflows/docs.yml
@@ -0,0 +1,73 @@
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# This workflow will build and deploy the MkDocs documentation to GitHub Pages
on pushes to specific branches.
+name: docs
+
+on:
+ push:
+ branches: [ ranger_5353, master ]
+
+permissions:
+ contents: write
+
+concurrency:
+ group: docs-${{ github.ref }}
+ cancel-in-progress: true
+
+jobs:
+ deploy:
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v4
+ with:
+ fetch-depth: 0
+
+ - name: Configure Git author
+ run: |
+ git config user.name "github-actions[bot]"
+ git config user.email
"41898282+github-actions[bot]@users.noreply.github.com"
+
+ - uses: actions/setup-python@v5
+ with:
+ python-version: '3.x'
+
+ # weekly cache for mkdocs' .cache to speed up rebuilds
+ - name: Compute cache key
+ run: echo "cache_id=$(date --utc +%V)" >> "$GITHUB_ENV"
+
+ - uses: actions/cache@v4
+ with:
+ key: mkdocs-material-${{ env.cache_id }}
+ path: .cache
+ restore-keys: |
+ mkdocs-material-
+
+ - name: Install dependencies
+ run: |
+ cd mkdocs
+ pip install --upgrade pip
+ pip install -r requirements.txt
+
+ # enable strict mode later
+ - name: Build (fail on warnings)
+ run: |
+ cd mkdocs
+ mkdocs build
+
+ - name: Deploy to GitHub Pages
+ run: |
+ cd mkdocs
+ mkdocs gh-deploy --force
diff --git a/mkdocs/README.md b/mkdocs/README.md
new file mode 100644
index 000000000..2ef307f77
--- /dev/null
+++ b/mkdocs/README.md
@@ -0,0 +1,60 @@
+<!---
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+# Apache Ranger Website and Documentation
+
+Welcome to the official website and documentation for Apache Ranger!
+
+## Installation
+
+This documentation site uses [MkDocs](https://www.mkdocs.org/)
documentation-focused static site engine, along with [Material for
MkDocs](https://squidfunk.github.io/mkdocs-material/) theme.
+
+Create and activate a new virtual environment:
+```bash
+python3 -m venv .venv
+```
+
+Activate the environment:
+```bash
+source .venv/bin/activate
+```
+
+Install the required dependencies:
+```bash
+pip install -r requirements.txt
+```
+
+Run site locally at http://localhost:8000:
+```bash
+mkdocs serve --strict
+```
+
+To run the site on a different port, such as 8080:
+```bash
+mkdocs serve --strict --dev-addr=127.0.0.1:8080
+```
+
+Build site for production:
+```bash
+mkdocs build
+```
+
+## Contributions
+
+We welcome contributions to the Ranger documentation by our community! See
[Contributing](./docs/project/contributing.md) for more information.
+
+To suggest changes, please create a new
[issue](https://github.com/apache/ranger/issues) or submit a [pull
request](https://github.com/apache/ranger/pulls) with the proposed change!
diff --git a/mkdocs/docs/arch/architecture.md b/mkdocs/docs/arch/architecture.md
new file mode 100644
index 000000000..d3be01ce3
--- /dev/null
+++ b/mkdocs/docs/arch/architecture.md
@@ -0,0 +1,18 @@
+<!---
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+# Ranger Architecture
diff --git a/mkdocs/docs/assets/brand/Satoshi-Variable.ttf
b/mkdocs/docs/assets/brand/Satoshi-Variable.ttf
new file mode 100644
index 000000000..976e85cb5
Binary files /dev/null and b/mkdocs/docs/assets/brand/Satoshi-Variable.ttf
differ
diff --git a/mkdocs/docs/assets/brand/favicon.ico
b/mkdocs/docs/assets/brand/favicon.ico
new file mode 100644
index 000000000..a7e00a51c
Binary files /dev/null and b/mkdocs/docs/assets/brand/favicon.ico differ
diff --git a/mkdocs/docs/assets/brand/merged-logo.svg
b/mkdocs/docs/assets/brand/merged-logo.svg
new file mode 100644
index 000000000..71dc4e915
--- /dev/null
+++ b/mkdocs/docs/assets/brand/merged-logo.svg
@@ -0,0 +1,50 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<svg id="Layer_1" xmlns="http://www.w3.org/2000/svg"; viewBox="0 0 1000 525">
+ <defs>
+ <style>
+ .cls-1 {
+ fill: #7c297d;
+ }
+
+ .cls-2 {
+ fill: #f79a23;
+ }
+
+ .cls-3 {
+ fill: #dd552c;
+ }
+
+ .cls-4 {
+ fill: #d22128;
+ }
+
+ .cls-5 {
+ fill: #ffffff;
+ }
+
+ .cls-6 {
+ fill: #cccccc;
+ }
+
+ .cls-7 {
+ fill: #cccccc;
+ }
+ </style>
+ </defs>
+ <g>
+ <g transform="translate(575,20) scale(11)">
+ <path class="cls-5" d="M16.7736 0.122444C14.3026 0.56362 12.2677 1.35774
9.38975 3.0048C5.29082 5.32833 1.42445 7.35774 0.66862 7.53421C0.0290704
7.71068 0 7.85774 0 10.4754C0 15.3871 1.45352 22.3871 3.31403 26.3871C4.44778
28.8577 5.93037 31.0048 6.51178 31.0048C6.71527 31.0048 7.23854 31.446 7.67459
32.0048C8.95369 33.7107 13.0817 36.8577 15.9306 38.2695L18.6051 39.6519L21.3086
38.2695C24.1866 36.7695 28.2855 33.6813 29.5356 32.0048C29.9716 31.446 30.4949
31.0048 30.6984 31.0048C [...]
+ <path class="cls-6" d="M15.6979 2.32855C13.5177 2.9462 11.5409 3.91679
7.70358 6.15208C5.93028 7.21091 4.0407 8.21091 3.48837 8.38738C1.91856 8.91679
1.74414 9.1815 1.74414 10.8286C1.74414 13.0933 2.52904 18.1521 3.34301
21.2109C4.5349 25.7403 5.55237 27.5344 8.80826 30.7109C12.1514 33.9462 13.6049
35.0638 16.541 36.5344L18.6631 37.5933L20.4946 36.6227C23.2563 35.1815 25.5238
33.4756 28.4308 30.6815C31.5995 27.6227 32.8204 25.3874 34.0414 20.4168C35.0298
16.3874 35.7275 10.2403 35. [...]
+ <path class="cls-7" d="M19.3027 20.6226C19.2155 21.0932 19.012 21.8873
18.8957 22.3873C18.6632 23.3285 18.6632 23.3579 19.6225 23.3579C21.8028 23.3579
22.9947 22.152 22.3842 20.5638C22.1516 19.9167 21.919 19.8285 20.7853
19.8285C19.5934 19.8285 19.4771 19.8873 19.3027 20.6226Z" fill="grey"/>
+ </g>
+ <g >
+ <path class="cls-3"
d="M141.1077177,209.8881008c13.1869872-32.608129,27.9005344-65.1523006,43.6878912-93.9970469-23.5665852-17.5041056-46.1956909-55.2490163-55.4930639-71.9721694-3.3392448,3.7936783-5.5070609,8.1629723-6.4899838,11.7176522-8.7587851,31.6252061,22.4204029,69.8144518-2.6929393,55.86166-20.9241385-11.6267655-68.040478-37.0885068-86.0124818-11.7816095,20.1280383,25.862316,72.7733189,90.9304622,107.0005776,110.1715137Z"/>
+ <path class="cls-2"
d="M184.7956089,115.8910539c15.2975784-27.9493439,31.5999598-52.4281623,48.5015202-70.0635487,0,0-16.8578001,24.4013964-40.9360438,73.180626,14.5822664,4.0158458,56.1124399,12.2562401,113.9601427-2.686207,1.4222086-10.5125619-5.645074-22.0753701-40.8636711-25.9464703-22.9926525-2.5246306,27.5975787-54.9023003-9.0516423-79.6739759-1.1832102-.8011494-2.3462234-1.508046-3.4856733-2.1408868-1.2286536-.4409688-2.5263137-.8449097-3.9114944-1.2050903-42.8025874-11.1689
[...]
+ <path class="cls-4"
d="M106.6818547,303.8380213c9.6626029-28.9457315,21.2860022-61.4663399,34.425863-93.9499204-34.2272587-19.2410514-86.8725393-84.3091977-107.0005776-110.1715137-3.5933909,5.0559936-6.0490149,12.1081284-6.8669953,21.7522173-4.3894911,51.802054,49.0518897,90.152876,38.3979485,97.1578844-14.0924881,9.2670774-42.1411341-22.2605096-53.19565-2.2284073,16.0229889,20.5841549,48.6614135,57.7770131,94.2394114,87.4397396Z"/>
+ <path class="cls-3"
d="M254.7564893,192.1180675c-27.0589909-9.6508213,28.2758628-35.5333343,46.2445004-62.9912168,2.2990969-3.5109196,4.6756159-8.0485224,5.3202382-12.8049265-57.8477027,14.942447-99.3778763,6.7020527-113.9601427,2.686207-12.4649429,25.2564046-26.8587035,57.0835812-41.8701571,95.4579665,15.6341958,6.6852219,79.4703224,31.3794754,169.6366631,31.50739,15.1595653-39.4852227-39.6905594-44.6994265-65.3711019-53.8554202Z"/>
+ <path class="cls-4"
d="M117.1371916,309.0488589c15.9001236,4.9550083,68.5841152,19.7560761,124.5366618,17.5276688,7.5166669-20.3518889-20.585838-22.3379316-22.8748364-38.6605101-1.7722907-12.6298854,73.9565291,10.6135471,98.3225807-35.3111668,1.2320197-2.3226602,2.1930625-4.5140395,3.0059935-6.6313631-90.1663407-.1279146-154.0024672-24.8221682-169.6366631-31.50739-10.9703615,28.0435968-22.2554604,59.5173251-33.3537365,94.5827612Z"/>
+ <path class="cls-1"
d="M117.1371916,309.0488589c-7.1447046,22.5701977-14.1934733,46.6821031-21.0352222,72.1640414-2.4270116,9.0348114-4.8254106,18.2379315-7.190148,27.6430221,53.1064464,17.531035,102.0085414.0403941,103.6663821-21.6377674.0134647-.1716749-.018514-.2995895-.0084154-.464532,1.2639984-22.9606739-33.150083-10.2331694-32.3354689-24.0378496.8179803-13.9056654,60.0811593-.0807882,78.4082944-29.8949926,1.4053777-2.2856322,2.3209771-4.3154353,3.0312398-6.244253-55.9525467,2
[...]
+ <path class="cls-1"
d="M12.4424433,216.3982816c-.7742201,1.4036946-1.4727012,3.0261906-2.068514,4.9651069-10.2920775,33.4496725,62.4846076,78.3847312,52.5830064,88.180298-8.9254108,8.8261086-20.5572255-11.3440069-34.9004936-3.0127259-1.5720033.9155994-3.1675699,2.0701971-4.8052136,3.749918-16.2215932,16.6188018-.2541461,64.4958967,45.7698699,90.0518908-10.7397786,36.0618236-21.4324308,76.351562-31.8995493,118.4859638,3.7970444-1.3296388,8.3413795-2.6626438,9.4724141-6.244253,1.6982
[...]
+ </g>
+ </g>
+</svg>
\ No newline at end of file
diff --git a/mkdocs/docs/assets/brand/ranger-logo.svg
b/mkdocs/docs/assets/brand/ranger-logo.svg
new file mode 100644
index 000000000..814255694
--- /dev/null
+++ b/mkdocs/docs/assets/brand/ranger-logo.svg
@@ -0,0 +1,17 @@
+<svg width="186" height="40" viewBox="0 0 186 40" fill="none"
xmlns="http://www.w3.org/2000/svg";>
+<path d="M16.7736 0.122444C14.3026 0.56362 12.2677 1.35774 9.38975
3.0048C5.29082 5.32833 1.42445 7.35774 0.66862 7.53421C0.0290704 7.71068 0
7.85774 0 10.4754C0 15.3871 1.45352 22.3871 3.31403 26.3871C4.44778 28.8577
5.93037 31.0048 6.51178 31.0048C6.71527 31.0048 7.23854 31.446 7.67459
32.0048C8.95369 33.7107 13.0817 36.8577 15.9306 38.2695L18.6051 39.6519L21.3086
38.2695C24.1866 36.7695 28.2855 33.6813 29.5356 32.0048C29.9716 31.446 30.4949
31.0048 30.6984 31.0048C30.9309 31.0048 31.5 [...]
+<path d="M15.6979 2.32855C13.5177 2.9462 11.5409 3.91679 7.70358
6.15208C5.93028 7.21091 4.0407 8.21091 3.48837 8.38738C1.91856 8.91679 1.74414
9.1815 1.74414 10.8286C1.74414 13.0933 2.52904 18.1521 3.34301 21.2109C4.5349
25.7403 5.55237 27.5344 8.80826 30.7109C12.1514 33.9462 13.6049 35.0638 16.541
36.5344L18.6631 37.5933L20.4946 36.6227C23.2563 35.1815 25.5238 33.4756 28.4308
30.6815C31.5995 27.6227 32.8204 25.3874 34.0414 20.4168C35.0298 16.3874 35.7275
10.2403 35.2623 9.41679C35.0879 [...]
+<path d="M19.3027 20.6226C19.2155 21.0932 19.012 21.8873 18.8957
22.3873C18.6632 23.3285 18.6632 23.3579 19.6225 23.3579C21.8028 23.3579 22.9947
22.152 22.3842 20.5638C22.1516 19.9167 21.919 19.8285 20.7853 19.8285C19.5934
19.8285 19.4771 19.8873 19.3027 20.6226Z" fill="#133653"/>
+<path d="M46.9778 16.0636C46.5417 17.4754 46.5708 17.7401 47.2394
17.8283C47.879 17.9165 47.7627 18.1812 45.2917 22.6812C43.0533 26.7989 42.5591
27.4754 41.9777 27.4754C41.5998 27.4754 41.28 27.6518 41.28 27.8283C41.28
28.0342 41.1928 28.5048 41.1056 28.8577C40.9311 29.5342 40.9602 29.5342 43.4021
29.5342C46.0475 29.5342 46.0475 29.5342 46.3382 28.2695C46.4836 27.593 46.4254
27.4754 45.9312 27.4754C45.6115 27.4754 45.3498 27.4165 45.3498 27.3283C45.3498
27.1518 46.2219 25.3577 46.3964 25 [...]
+<path d="M91.281 16.0636C91.281 16.2695 91.1938 16.7401 91.1066 17.093C90.9612
17.6518 91.0484 17.7695 91.5717 17.7695C92.095 17.7695 92.1822 17.8871 92.0368
18.4165C91.9496 18.7989 91.4554 20.9754 90.9322 23.2695C90.1472 26.6812 89.8856
27.4754 89.4786 27.4754C89.1589 27.4754 88.8972 27.8283 88.7228 28.4165L88.4902
29.3871L90.9322 29.4754C92.2985 29.5342 93.4322 29.5048 93.4903 29.4459C93.5485
29.3871 93.6938 28.9165 93.7811 28.4165C93.9555 27.593 93.8973 27.4754 93.345
27.4754C92.8799 [...]
+<path d="M119.246 16.6518C119.043 17.5048 119.072 17.6518 119.624
17.7695L120.264 17.9165L119.217 22.6224C118.316 26.6224 118.084 27.3283 117.589
27.4165C116.834 27.5636 116.688 27.7401 116.456 28.7107L116.281
29.5342H119.334C121.572 29.5342 122.386 29.4459 122.386 29.1518C122.386 28.9754
122.473 28.5048 122.56 28.1224C122.706 27.593 122.619 27.4754 122.095
27.4754C121.398 27.4754 121.398 27.1812 122.124 24.4754C122.386 23.4459 122.502
23.3577 123.404 23.3577C124.508 23.3577 124.363 23.0 [...]
+<path d="M70.9025 20.0342C68.8675 20.5636 68.7513 20.6812 69.478
21.4459C70.0594 22.0636 70.1466 22.093 71.2804 21.6812C72.9374 21.1224 74.1293
21.593 74.1293 22.7989V23.6518H72.1816C69.9141 23.6518 68.3733 24.2695 67.821
25.4165C66.8035 27.4459 67.9954 29.5342 70.1176 29.5342C70.7571 29.5342 71.542
29.3871 71.8909 29.2107C72.356 28.9459 72.5304 28.9459 72.6176 29.2107C72.6758
29.4165 73.5188 29.5342 74.827 29.5342H76.9491L77.2398 28.5048C77.5596 27.5048
77.5305 27.4754 76.7456 27.4754H7 [...]
+<path d="M105.817 19.8284C102.706 20.3872 100.904 23.2696 101.485
26.7108C101.98 29.7108 106.137 30.7696 108.84 28.6225C109.799 27.8578 109.799
27.6225 108.724 27.1813C107.968 26.8578 107.794 26.9166 107.096 27.4461C106.66
27.799 106.078 28.0637 105.759 28.0637C104.945 28.0637 103.724 26.7108 103.84
25.9166C103.927 25.299 104.073 25.2696 106.398 25.2402C111.224 25.1519 110.759
25.2696 110.759 23.9166C110.759 21.0049 108.695 19.3284 105.817
19.8284ZM107.794 21.946C107.997 22.1519 108.142 [...]
+<path d="M135.294 19.8283C134.48 19.9459 133.52 20.2106 133.171
20.4165L132.503 20.7695L133.142 21.4459C133.753 22.093 133.811 22.093 134.887
21.6812C136.311 21.093 137.648 21.6224 137.648 22.7695C137.648 23.4754 137.561
23.5048 135.468 23.6518C132.154 23.8871 131.136 24.6518 131.107 26.9459C131.107
28.093 131.224 28.4165 131.863 28.9165C132.706 29.593 134.102 29.7107 135.381
29.2107C135.933 29.0048 136.224 29.0048 136.282 29.2107C136.34 29.4165 137.241
29.5342 138.404 29.5342C140.294 29 [...]
+<path d="M170.934 19.8284C167.823 20.3872 166.021 23.2696 166.603
26.7108C167.097 29.7108 171.254 30.7696 173.957 28.6225C174.917 27.8578 174.917
27.6225 173.841 27.1813C173.085 26.8578 172.911 26.9166 172.213 27.4461C171.777
27.799 171.196 28.0637 170.876 28.0637C170.062 28.0637 168.841 26.7108 168.957
25.9166C169.044 25.299 169.19 25.2696 171.515 25.2402C176.341 25.1519 175.876
25.2696 175.876 23.9166C175.876 21.0049 173.812 19.3284 170.934
19.8284ZM173.143 22.446C173.725 23.6225 173.4 [...]
+<path d="M56.7742 20.0929C56.5998 20.1811 56.3963 20.6223 56.28
21.0634C56.1347 21.7693 56.1928 21.887 56.687 21.887C57.0068 21.887 57.2684
22.0634 57.2684 22.2987C57.2684 22.5046 56.8033 24.6517 56.2509 27.0634C55.6986
29.4752 55.2335 31.534 55.2335 31.6517C55.2335 31.7987 54.9137 31.887 54.5358
31.887C53.8381 31.887 53.4893 32.3576 53.4893 33.387C53.4893 33.887 53.7218
33.9458 56.2509 33.9458H58.9836L59.2452 32.9752C59.4778 32.0929 59.4487 32.034
58.6929 31.9458C57.8498 31.8576 57.8498 [...]
+<path d="M82.269 20.2991C79.8853 21.3579 78.8969 23.3285 79.0422
26.7991C79.1004 27.8285 80.8737 29.4461 82.2109 29.6814C83.7516 29.9461 85.4959
29.4167 86.6005 28.3873C87.7052 27.3285 87.7343 27.0638 86.6587 26.5932C85.9028
26.2991 85.6994 26.3285 84.9435 26.8873C83.1702 28.2108 81.3969 27.0049 81.8039
24.7402C82.24 22.4167 84.304 21.2991 85.6412 22.6226C86.0773 23.0638 86.6878
23.3579 87.211 23.3579C87.9378 23.3579 88.0831 23.2108 88.3448 22.2402C88.5192
21.652 88.6645 20.8579 88.6645 [...]
+<path d="M148.695 20.4165C147.329 21.1224 147.271 21.1224 147.504
20.5636C147.62 20.1812 147.3 20.1224 145.498 20.1224C143.812 20.1224 143.317
20.2106 143.317 20.5342C143.317 20.7695 143.23 21.1518 143.143 21.4165C142.998
21.7695 143.143 21.8871 143.753 21.8871C144.277 21.8871 144.48 22.0048 144.393
22.2401C144.335 22.4459 144.044 23.7106 143.753 25.0342C143.346 27.0048 143.143
27.4754 142.707 27.4754C142.358 27.4754 142.096 27.7989 141.922 28.4165L141.689
29.3871L144.131 29.4754C145.498 [...]
+<path d="M157.271 20.4458C155.701 21.3576 154.858 22.887 154.713
25.0635C154.567 27.2693 155.004 28.5046 156.137 29.0929C157.271 29.6811 158.405
29.6517 159.539 28.9458C160.033 28.6223 160.469 28.5046 160.469 28.6517C160.469
29.387 159.597 30.9752 158.986 31.4164C158.143 32.0046 156.137 32.034 154.8
31.4752C153.841 31.0635 153.812 31.0635 153.521 31.9458C153.347 32.4458 153.201
32.9458 153.201 33.0635C153.201 33.534 155.876 34.0046 157.794 33.887C159.451
33.7988 160.004 33.6223 160.876 3 [...]
+<path d="M180.382 20.0636C178.637 20.1518 178.201 20.4165 178.201
21.3577C178.201 21.7107 178.434 21.8871 178.812 21.8871C179.19 21.8871 179.364
22.0342 179.277 22.2401C179.219 22.4459 178.928 23.7107 178.637 25.0342C178.172
27.2401 178.056 27.4754 177.446 27.4754C176.951 27.4754 176.748 27.6518 176.748
28.0342C176.748 28.3577 176.661 28.7989 176.573 29.0636C176.428 29.4754 176.748
29.5342 179.19 29.5342C181.225 29.5342 181.981 29.4459 181.981 29.1518C181.981
28.9754 182.068 28.5048 182. [...]
+</svg>
diff --git a/mkdocs/docs/assets/css/custom.css
b/mkdocs/docs/assets/css/custom.css
new file mode 100644
index 000000000..e42a8ce0d
--- /dev/null
+++ b/mkdocs/docs/assets/css/custom.css
@@ -0,0 +1,102 @@
+@font-face {
+ font-family: 'Satoshi';
+ src: url("../brand/Satoshi-Variable.ttf") format("truetype");
+ font-display: swap;
+}
+
+/* This file is used to add custom styles to the MkDocs Material theme. */
+/* It overrides only dark mode colors to create a "slate" theme. */
+:root, [data-md-color-scheme="slate"] {
+ --md-default-bg-color: rgb(26, 26, 27);
+ --md-primary-fg-color: rgb(15, 15, 15);
+ --md-primary-fg-color--light: #5FFFD7;
+ --md-primary-fg-color--dark: #FCDB17;
+ --md-primary-bg-color: rgba(0,0,0,.75);
+ --md-primary-bg-color--light: rgba(0,0,0,.54);
+ --md-accent-fg-color: #FCDB17; /* this is also good: #00bad6 but only for
the landing page */
+ --pg-light-border: rgb(47, 47, 47);
+ --hb-hero-color: #5FFFD7;
+ /* --md-footer-bg-color--dark: var(--md-default-bg-color); */
+}
+
+/* Tested: === Common font styling === */
+.md-header__topic:first-child,
+.md-typeset h1,
+h2,
+h3 {
+ font-family: 'Satoshi';
+}
+
+/* Tested: === Dark mode (slate) overrides === */
+[data-md-color-scheme="slate"] .md-typeset h1 {
+ color: var(--md-typeset-a-color);
+}
+
+/* Tested: === Dark mode button hover and click */
+[data-md-color-scheme="slate"] .md-typeset .md-button:hover,
+[data-md-color-scheme="slate"] .md-typeset .md-button:focus,
+[data-md-color-scheme="slate"] .md-typeset .md-button:active {
+ background-color: var(--md-accent-fg-color);
+ color: #000000;
+ border-color: var(--md-accent-fg-color);
+}
+
+
+#typewriter {
+ color: var(--md-accent-fg-color);
+}
+
+[data-md-color-scheme="slate"] > * {
+ --md-typeset-a-color: #5FFFD7;
+}
+
+[data-md-color-scheme="slate"] .md-header >*, [data-md-color-scheme="slate"]
.md-tabs {
+ color: #fff;
+}
+
+[data-md-color-scheme="slate"] .md-header, [data-md-color-scheme="slate"]
.md-tabs { /* firefox fallback */
+ background-color: rgba(9, 9, 9, 0.95);
+}
+
+@supports ((-webkit-backdrop-filter: none) or (backdrop-filter: none)) {
+ [data-md-color-scheme="slate"] .md-header, [data-md-color-scheme="slate"]
.md-tabs {
+ background-color: rgba(0, 0, 0, 0.5);
+ -webkit-backdrop-filter: blur(12px);
+ backdrop-filter: blur(12px);
+ }
+}
+
+[data-md-color-scheme="slate"] .md-nav--primary .md-nav__title[for="__drawer"]
{
+ color: var(--md-typeset-a-color)
+}
+
+[data-md-color-scheme="slate"] .light-logo {
+ display: none;
+}
+
+/* Accent color */
+.accent {
+ color: var(--md-typeset-a-color);
+}
+.accent a {
+ font-weight: 500;
+}
+
+/* Primary buttons */
+.md-main .md-button--primary {
+ color: var(--md-primary-fg-color);
+ background-color: var(--hb-hero-color);
+ border-color: transparent;
+}
+
+.md-typeset hr {
+ margin-top: 5rem;
+ margin-bottom: 5rem;
+}
+
+/* logo size */
+.md-header__button.md-logo img {
+ height: 2rem;
+ width: auto; /* preserve aspect ratio */
+ max-height: 40px; /* keep header tidy on small screens */
+}
diff --git a/mkdocs/docs/assets/css/search-bar.css
b/mkdocs/docs/assets/css/search-bar.css
new file mode 100644
index 000000000..0e86f2302
--- /dev/null
+++ b/mkdocs/docs/assets/css/search-bar.css
@@ -0,0 +1,91 @@
+/* search bar css */
+[data-md-color-scheme="slate"] {
+ @media screen and (min-width: 60em) {
+ .md-search__overlay {
+ background-color: transparent;
+ }
+
+ .md-search__form {
+ border: 1px solid var(--pg-light-border);
+ background-color: var(--md-primary-fg-color) !important;
+ box-shadow: rgba(0, 0, 0, 0) 0px 0px 0px 0px, rgba(0, 0, 0, 0) 0px
0px 0px 0px, rgba(0, 0, 0, 0.02) 0px 1px 3px 0px, rgba(0, 0, 0, 0.02) 0px 1px
2px -1px;
+ border-radius: 6px;
+ height: 1.4rem;
+ }
+
+ [data-md-toggle="search"]:checked ~ .md-header .md-search__form {
+ border-radius: 6px 6px 0 0;
+ }
+
+ [dir="ltr"] .md-search__output {
+ top: initial;
+ border-radius: 0 0 6px 6px;
+ }
+
+ [data-md-toggle="search"]:checked ~ .md-header .md-search__output {
+ box-shadow: 0 0 .6rem rgba(0,0,0,.07);
+ }
+
+ .md-search__input {
+ font-size: .6rem;
+ }
+
+ .md-search__options {
+ top: .05rem;
+ }
+
+ .md-search__icon, .md-search__input::placeholder {
+ color: var(--md-default-fg-color--light) !important;
+ }
+
+ .md-search__icon svg {
+ width: .75rem;
+ height: .75rem;
+ }
+ }
+}
+[data-md-color-scheme="default"]{
+ @media screen and (min-width: 60em) {
+ .md-search__overlay {
+ background-color: transparent;
+ }
+
+ .md-search__form {
+ border: 1px solid var(--pg-light-border);
+ background-color: var(--md-primary-fg-color) !important;
+ box-shadow: rgba(0, 0, 0, 0) 0px 0px 0px 0px, rgba(0, 0, 0, 0) 0px
0px 0px 0px, rgba(0, 0, 0, 0.02) 0px 1px 3px 0px, rgba(0, 0, 0, 0.02) 0px 1px
2px -1px;
+ border-radius: 6px;
+ height: 1.4rem;
+ }
+
+ [data-md-toggle="search"]:checked ~ .md-header .md-search__form {
+ border-radius: 6px 6px 0 0;
+ }
+
+ [dir="ltr"] .md-search__output {
+ top: initial;
+ border-radius: 0 0 6px 6px;
+ }
+
+ [data-md-toggle="search"]:checked ~ .md-header .md-search__output {
+ box-shadow: 0 0 .6rem rgba(0,0,0,.07);
+ }
+
+ .md-search__input {
+ font-size: .6rem;
+ }
+
+ .md-search__options {
+ top: .05rem;
+ }
+
+ .md-search__icon, .md-search__input::placeholder {
+ color: var(--md-default-fg-color--light) !important;
+ }
+
+ .md-search__icon svg {
+ width: .75rem;
+ height: .75rem;
+ }
+ }
+}
\ No newline at end of file
diff --git a/mkdocs/docs/assets/css/table.css b/mkdocs/docs/assets/css/table.css
new file mode 100644
index 000000000..4b8186059
--- /dev/null
+++ b/mkdocs/docs/assets/css/table.css
@@ -0,0 +1,30 @@
+/* 1) Target Material's table wrapper + the table itself */
+.md-page--cve-list .md-typeset__table { width: 100%; }
+.md-page--cve-list .md-typeset__table > table {
+ table-layout: fixed; /* equal, predictable columns */
+ width: 100%;
+}
+
+/* 2) Lock first/second column widths for 2-col CVE tables */
+/* Scope table rules only to cve-list.md */
+.md-page--cve-list .md-typeset__table > table th:first-child,
+.md-page--cve-list .md-typeset__table > table td:first-child {
+ width: 22ch; /* CVE / field name */
+}
+
+.md-page--cve-list .md-typeset__table > table th:nth-child(2),
+.md-page--cve-list .md-typeset__table > table td:nth-child(2) {
+ width: auto; /* description/value */
+}
+
+/* Prevent content from blowing up column width */
+.md-page--cve-list .md-typeset__table > table td,
+.md-page--cve-list .md-typeset__table > table th {
+ word-break: break-word;
+ overflow-wrap: anywhere;
+}
+
+/* Allow code to wrap normally inside cells */
+.md-page--cve-list .md-typeset__table > table code {
+ white-space: normal;
+}
diff --git a/mkdocs/docs/assets/js/typewriter.js
b/mkdocs/docs/assets/js/typewriter.js
new file mode 100644
index 000000000..0ae794724
--- /dev/null
+++ b/mkdocs/docs/assets/js/typewriter.js
@@ -0,0 +1,35 @@
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+document$.subscribe(() => {
+ const el = document.querySelector('#typewriter');
+ if (!el) return;
+
+ const instance = new Typewriter(el, {
+ strings: [
+ 'data processing platforms',
+ 'Apache Spark',
+ 'Trino',
+ 'Apache Hive',
+ 'Apache Ozone',
+ 'Apache Hadoop'
+ ],
+ autoStart: true,
+ loop: true,
+ });
+});
diff --git a/mkdocs/docs/blog/blog.md b/mkdocs/docs/blog/blog.md
new file mode 100644
index 000000000..c1996a386
--- /dev/null
+++ b/mkdocs/docs/blog/blog.md
@@ -0,0 +1,18 @@
+<!---
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+# Welcome to Blogs!
diff --git a/mkdocs/docs/features/client-interface/intro.md
b/mkdocs/docs/features/client-interface/intro.md
new file mode 100644
index 000000000..0f2f0366a
--- /dev/null
+++ b/mkdocs/docs/features/client-interface/intro.md
@@ -0,0 +1,29 @@
+---
+title: "Ranger Client Libraries"
+---
+<!--
+ - Licensed to the Apache Software Foundation (ASF) under one or more
+ - contributor license agreements. See the NOTICE file distributed with
+ - this work for additional information regarding copyright ownership.
+ - The ASF licenses this file to You under the Apache License, Version 2.0
+ - (the "License"); you may not use this file except in compliance with
+ - the License. You may obtain a copy of the License at
+ -
+ - http://www.apache.org/licenses/LICENSE-2.0
+ -
+ - Unless required by applicable law or agreed to in writing, software
+ - distributed under the License is distributed on an "AS IS" BASIS,
+ - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ - See the License for the specific language governing permissions and
+ - limitations under the License.
+ -->
+
+# Introduction
+
+Ranger provides client libraries in Java and Python to access Ranger REST APIs
programmatically with ease.
+
+## Python
+
+For more details, please refer to [Ranger Python Client
Library](https://pypi.org/project/apache-ranger/).
+
+## Java
diff --git a/mkdocs/docs/features/gds/gds_intro.md
b/mkdocs/docs/features/gds/gds_intro.md
new file mode 100644
index 000000000..224171a45
--- /dev/null
+++ b/mkdocs/docs/features/gds/gds_intro.md
@@ -0,0 +1,18 @@
+<!---
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+# Governed Data Sharing
diff --git a/mkdocs/docs/features/sec-zone/intro.md
b/mkdocs/docs/features/sec-zone/intro.md
new file mode 100644
index 000000000..6c969cd5b
--- /dev/null
+++ b/mkdocs/docs/features/sec-zone/intro.md
@@ -0,0 +1,18 @@
+<!---
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+## What is a Security Zone ?
diff --git a/mkdocs/docs/getting-started/install.md
b/mkdocs/docs/getting-started/install.md
new file mode 100644
index 000000000..b164fc94d
--- /dev/null
+++ b/mkdocs/docs/getting-started/install.md
@@ -0,0 +1,22 @@
+---
+title: Getting started with Ranger
+---
+<!---
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+[Docker Docs]: https://docs.docker.com/get-started/overview/
+# Installation
diff --git a/mkdocs/docs/getting-started/trino-with-ranger.md
b/mkdocs/docs/getting-started/trino-with-ranger.md
new file mode 100644
index 000000000..6c53902b0
--- /dev/null
+++ b/mkdocs/docs/getting-started/trino-with-ranger.md
@@ -0,0 +1,24 @@
+---
+title: "Trino with Ranger"
+---
+<!--
+ - Licensed to the Apache Software Foundation (ASF) under one or more
+ - contributor license agreements. See the NOTICE file distributed with
+ - this work for additional information regarding copyright ownership.
+ - The ASF licenses this file to You under the Apache License, Version 2.0
+ - (the "License"); you may not use this file except in compliance with
+ - the License. You may obtain a copy of the License at
+ -
+ - http://www.apache.org/licenses/LICENSE-2.0
+ -
+ - Unless required by applicable law or agreed to in writing, software
+ - distributed under the License is distributed on an "AS IS" BASIS,
+ - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ - See the License for the specific language governing permissions and
+ - limitations under the License.
+ -->
+
+[DockerHub]: https://hub.docker.com/r/apache/ranger
+## Introduction
+
+This guide will walk you through the steps to run Trino with Apache Ranger as
the Access Control Enforcer.
diff --git a/mkdocs/docs/index.md b/mkdocs/docs/index.md
new file mode 100644
index 000000000..31fbc66aa
--- /dev/null
+++ b/mkdocs/docs/index.md
@@ -0,0 +1,35 @@
+---
+template: home.html
+title: Apache Ranger - the open source authz framework for data processing
services
+hide:
+ - toc
+ - navigation
+ - feedback
+---
+<!---
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+# Goals Overview
+
+- Centralized security administration to manage all authorization related
tasks in a central UI or using REST APIs.
+- Fine-grained authorization to do a specific action and/or operation with 20+
data processing services and managed through a central administration tool.
+- Standardized authorization method across different data processing services.
+- Enhanced support for different authorization methods like:
+ - Role based access control (RBAC)
+ - Attribute based access control (ABAC)
+ - Tag based access control (TBAC)
+- Centralized auditing of user access and administrative actions (security
related) for all services.
diff --git a/mkdocs/docs/overrides/home.html b/mkdocs/docs/overrides/home.html
new file mode 100644
index 000000000..3ce88de98
--- /dev/null
+++ b/mkdocs/docs/overrides/home.html
@@ -0,0 +1,135 @@
+<!---
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+{% extends "base.html" %}
+
+{% block tabs %}
+ {{ super() }}
+<!-- Additional styles for landing page -->
+<style>
+ .mdx-container {
+ background: url("data:image/svg+xml;utf8,<svg width='100%'
height='100%' viewBox='0 0 1123 258' version='1.1'
xmlns='http://www.w3.org/2000/svg' xmlns:xlink='http://www.w3.org/1999/xlink'
xml:space='preserve' xmlns:serif='http://www.serif.com/'
style='fill-rule:evenodd;clip-rule:evenodd;stroke-linejoin:round;stroke-miterlimit:2;'><g
transform='matrix(-1.01432,0,0,0.388868,1134.41,161.501)'><path
d='M1124,2L1124,258L-1,258L-1,210C-1,210 15,215 54,215C170,215 251,123
379,123C500,12 [...]
+ no-repeat bottom,
+ linear-gradient(to bottom, rgb(255 255 255/.8), #00C2CE 99%,
var(--md-default-bg-color) 99%);
+ background-size: contain;
+ padding-top: 1rem;
+ }
+ [data-md-color-scheme="slate"] .mdx-container {
+ background: url("data:image/svg+xml;utf8,<svg width='100%'
height='100%' viewBox='0 0 1123 258' version='1.1'
xmlns='http://www.w3.org/2000/svg' xmlns:xlink='http://www.w3.org/1999/xlink'
xml:space='preserve' xmlns:serif='http://www.serif.com/'
style='fill-rule:evenodd;clip-rule:evenodd;stroke-linejoin:round;stroke-miterlimit:2;'><g
transform='matrix(-1.01432,0,0,0.388868,1134.41,161.501)'><path
d='M1124,2L1124,258L-1,258L-1,210C-1,210 15,215 54,215C170,215 251,123
379,123C500,12 [...]
+ no-repeat bottom, rgba(9, 9, 9, 0.95);
+ background-size: contain;
+ }
+
+ .mdx-hero {
+ margin: 0 0.8rem;
+ }
+
+ .mdx-hero h1 {
+ color: currentcolor;
+ margin-bottom: 1rem;
+ font-size: 2.6rem;
+ }
+ @media screen and (max-width: 29.9375em) {
+ .mdx-hero h1 {
+ font-size: 1.4rem;
+ }
+ }
+ .mdx-hero__content {
+ padding-bottom: 6rem;
+ }
+
+ @media screen and (min-width: 60em) {
+ .mdx-hero {
+ align-items: stretch;
+ display: flex;
+ }
+ .mdx-hero__content {
+ margin-top: 3.5rem;
+ max-width: 38rem;
+ padding-bottom: 14vw;
+ }
+ .mdx-hero__image {
+ order: 1;
+ transform: translateX(4rem);
+ width: 38rem;
+ }
+ }
+ @media screen and (min-width: 76.25em) {
+ .mdx-hero__image {
+ transform: translateX(8rem);
+ }
+ }
+ .mdx-hero .md-button {
+ color: #000000;
+ border-color: #000000;
+ }
+ [data-md-color-scheme="slate"] .mdx-hero .md-button--primary {
+ color: var(--md-primary-fg-color);
+ }
+
+ .mdx-hero .md-button--primary {
+ color: #ffffff;
+ background-color: #000000;
+ border-color: transparent;
+ margin-right: 0.5rem;
+ margin-top: 0.5rem;
+ margin-bottom: 0.5rem;
+ }
+
+ .md-main .md-button--primary {
+ color: #ffffff;
+ background-color: #000000;
+ border-color: transparent;
+ }
+
+ nav[class="md-tabs"] {
+ border-bottom: none;
+ }
+
+ /* extras */
+ [data-md-color-scheme="slate"] .mdx-hero h1 {
+ color: aquamarine;
+ }
+
+ [data-md-color-scheme="slate"] .md-typeset h3 {
+ color: aquamarine;
+ }
+
+ [data-md-color-scheme="slate"] .mdx-hero .md-button {
+ color: aquamarine;
+ border-color: aquamarine;
+ }
+
+</style>
+
+<section class="mdx-container">
+ <div class="md-grid md-typeset">
+ <div class="mdx-hero">
+ <div class="mdx-hero__content">
+ <h1>The open source, community owned authorization framework
for<div id="typewriter">data processing platforms</div></h1>
+ <h3>Apache Ranger is an open source framework that helps you
enable, monitor and manage comprehensive data security for your
applications</h3>
+ <a href="./getting-started/install/" class="md-button
md-button--primary">
+ Install Ranger
+ </a>
+ <a href="https://github.com/apache/ranger"; class="md-button"
target="_blank">
+ View on GitHub
+ </a>
+ </div>
+ </div>
+ </div>
+</section>
+{% endblock %}
\ No newline at end of file
diff --git a/mkdocs/docs/plugins/trino.md b/mkdocs/docs/plugins/trino.md
new file mode 100644
index 000000000..3a8b7491f
--- /dev/null
+++ b/mkdocs/docs/plugins/trino.md
@@ -0,0 +1,18 @@
+<!---
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+# Trino with Ranger
diff --git a/mkdocs/docs/project/asf-index.md b/mkdocs/docs/project/asf-index.md
new file mode 100644
index 000000000..9dab971a6
--- /dev/null
+++ b/mkdocs/docs/project/asf-index.md
@@ -0,0 +1,25 @@
+<!---
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+# ASF
+
+### [Sponsorship](https://www.apache.org/foundation/sponsorship.html)
+### [Events](https://www.apache.org/events/current-event.html)
+### [Privacy](https://privacy.apache.org/policies/privacy-policy-public.html)
+### [License](https://www.apache.org/licenses/)
+### [Security](https://www.apache.org/security/)
+### [Sponsors](https://www.apache.org/foundation/sponsors.html)
diff --git a/mkdocs/docs/project/contributing.md
b/mkdocs/docs/project/contributing.md
new file mode 100644
index 000000000..bb6c480df
--- /dev/null
+++ b/mkdocs/docs/project/contributing.md
@@ -0,0 +1,21 @@
+---
+title: "Contribute"
+---
+<!--
+ - Licensed to the Apache Software Foundation (ASF) under one or more
+ - contributor license agreements. See the NOTICE file distributed with
+ - this work for additional information regarding copyright ownership.
+ - The ASF licenses this file to You under the Apache License, Version 2.0
+ - (the "License"); you may not use this file except in compliance with
+ - the License. You may obtain a copy of the License at
+ -
+ - http://www.apache.org/licenses/LICENSE-2.0
+ -
+ - Unless required by applicable law or agreed to in writing, software
+ - distributed under the License is distributed on an "AS IS" BASIS,
+ - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ - See the License for the specific language governing permissions and
+ - limitations under the License.
+ -->
+
+# Contributing
diff --git a/mkdocs/docs/project/cve-list.md b/mkdocs/docs/project/cve-list.md
new file mode 100644
index 000000000..df87d728a
--- /dev/null
+++ b/mkdocs/docs/project/cve-list.md
@@ -0,0 +1,22 @@
+---
+title: "Vulnerabilities Found in Apache Ranger"
+---
+<!--
+ - Licensed to the Apache Software Foundation (ASF) under one or more
+ - contributor license agreements. See the NOTICE file distributed with
+ - this work for additional information regarding copyright ownership.
+ - The ASF licenses this file to You under the Apache License, Version 2.0
+ - (the "License"); you may not use this file except in compliance with
+ - the License. You may obtain a copy of the License at
+ -
+ - http://www.apache.org/licenses/LICENSE-2.0
+ -
+ - Unless required by applicable law or agreed to in writing, software
+ - distributed under the License is distributed on an "AS IS" BASIS,
+ - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ - See the License for the specific language governing permissions and
+ - limitations under the License.
+ -->
+
+## Introduction
+This page contains a list of security vulnerabilities that have been found in
Apache Ranger. For each vulnerability, the following information is provided:
diff --git a/mkdocs/docs/project/java-code-style.md
b/mkdocs/docs/project/java-code-style.md
new file mode 100644
index 000000000..417783def
--- /dev/null
+++ b/mkdocs/docs/project/java-code-style.md
@@ -0,0 +1,21 @@
+---
+title: "Java Style Guide"
+---
+<!--
+ - Licensed to the Apache Software Foundation (ASF) under one or more
+ - contributor license agreements. See the NOTICE file distributed with
+ - this work for additional information regarding copyright ownership.
+ - The ASF licenses this file to You under the Apache License, Version 2.0
+ - (the "License"); you may not use this file except in compliance with
+ - the License. You may obtain a copy of the License at
+ -
+ - http://www.apache.org/licenses/LICENSE-2.0
+ -
+ - Unless required by applicable law or agreed to in writing, software
+ - distributed under the License is distributed on an "AS IS" BASIS,
+ - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ - See the License for the specific language governing permissions and
+ - limitations under the License.
+ -->
+
+# Java Code Style Guide
diff --git a/mkdocs/docs/project/release-process.md
b/mkdocs/docs/project/release-process.md
new file mode 100644
index 000000000..f1a796741
--- /dev/null
+++ b/mkdocs/docs/project/release-process.md
@@ -0,0 +1,18 @@
+<!---
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+# Release Process
diff --git a/mkdocs/docs/release-notes/index.md
b/mkdocs/docs/release-notes/index.md
new file mode 100644
index 000000000..966ef7a2a
--- /dev/null
+++ b/mkdocs/docs/release-notes/index.md
@@ -0,0 +1,20 @@
+---
+title: "Ranger Releases"
+---
+<!--
+ - Licensed to the Apache Software Foundation (ASF) under one or more
+ - contributor license agreements. See the NOTICE file distributed with
+ - this work for additional information regarding copyright ownership.
+ - The ASF licenses this file to You under the Apache License, Version 2.0
+ - (the "License"); you may not use this file except in compliance with
+ - the License. You may obtain a copy of the License at
+ -
+ - http://www.apache.org/licenses/LICENSE-2.0
+ -
+ - Unless required by applicable law or agreed to in writing, software
+ - distributed under the License is distributed on an "AS IS" BASIS,
+ - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ - See the License for the specific language governing permissions and
+ - limitations under the License.
+ -->
+# Apache Ranger Releases
diff --git a/mkdocs/docs/services/admin/service.md
b/mkdocs/docs/services/admin/service.md
new file mode 100644
index 000000000..03a1f23bf
--- /dev/null
+++ b/mkdocs/docs/services/admin/service.md
@@ -0,0 +1,18 @@
+<!---
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+# Ranger Admin
diff --git a/mkdocs/docs/services/kms/service.md
b/mkdocs/docs/services/kms/service.md
new file mode 100644
index 000000000..46dd80da3
--- /dev/null
+++ b/mkdocs/docs/services/kms/service.md
@@ -0,0 +1,18 @@
+<!---
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+# Ranger KMS
diff --git a/mkdocs/docs/services/tagsync/service.md
b/mkdocs/docs/services/tagsync/service.md
new file mode 100644
index 000000000..5488fbff2
--- /dev/null
+++ b/mkdocs/docs/services/tagsync/service.md
@@ -0,0 +1,18 @@
+<!---
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+# Ranger TagSync
diff --git a/mkdocs/docs/services/usersync/service.md
b/mkdocs/docs/services/usersync/service.md
new file mode 100644
index 000000000..9800c5c5b
--- /dev/null
+++ b/mkdocs/docs/services/usersync/service.md
@@ -0,0 +1,18 @@
+<!---
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+# Ranger UserSync
diff --git a/mkdocs/mkdocs.yml b/mkdocs/mkdocs.yml
new file mode 100644
index 000000000..9c3107ac7
--- /dev/null
+++ b/mkdocs/mkdocs.yml
@@ -0,0 +1,158 @@
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Project info
+site_name: Apache Ranger
+site_url: https://apache.github.io/ranger/
+
+# Repository
+repo_name: 'apache/ranger'
+repo_url: 'https://github.com/apache/ranger'
+edit_uri: 'https://github.com/apache/ranger/blob/master/'
+
+copyright: Copyright © 2014-2025 The Apache Software Foundation
+
+theme:
+ name: material
+ custom_dir: docs/overrides
+ logo: assets/brand/merged-logo.svg
+ favicon: assets/brand/favicon.ico
+ icon:
+ repo: fontawesome/brands/github
+ palette:
+ - scheme: default
+ accent: deep purple
+ toggle:
+ icon: material/brightness-5 # ☀️
+ name: Switch to dark mode
+ - scheme: slate
+ accent: amber
+ toggle:
+ icon: material/brightness-2 # 🌙
+ name: Switch to light mode
+ font: # comment it out and see subtle difference
+ text: Noto Sans
+ code: Roboto Mono
+ features:
+ - navigation.instant
+ - navigation.instant.prefetch
+ - navigation.top
+ - navigation.tracking
+ - navigation.tabs
+ - navigation.path
+ - navigation.indexes
+ - navigation.prune
+ - content.code.copy
+ - toc.follow
+ - announce.dismiss
+
+plugins:
+ - search
+ - table-reader
+ - git-revision-date-localized:
+ fallback_to_build_date: true
+ type: date
+ timezone: America/Los_Angeles
+ - social:
+ cards_layout_options:
+ background_color: "#151819"
+ color: "#5FFFD7"
+
+nav:
+ - Home: index.md
+ - Getting started:
+ - Installation: getting-started/install.md
+ - Trino with Ranger: getting-started/trino-with-ranger.md
+ - Architecture:
+ - Overview: arch/architecture.md
+ - Plugins:
+ - Trino: plugins/trino.md
+ - Services:
+ - Ranger Admin: services/admin/service.md
+ - Ranger KMS: services/kms/service.md
+ - Ranger UserSync: services/usersync/service.md
+ - Ranger TagSync: services/tagsync/service.md
+ - Features:
+ - Governed Data Sharing: features/gds/gds_intro.md
+ - Security Zones:
+ - Introduction: features/sec-zone/intro.md
+ - Client Libraries:
+ - Introduction: features/client-interface/intro.md
+ - Project:
+ - Contributing: project/contributing.md
+ - Code Style Guide: project/java-code-style.md
+ - Release Process: project/release-process.md
+ - ASF:
+ - ASF: project/asf-index.md
+ - Sponsorship: "https://www.apache.org/foundation/sponsorship.html";
+ - Events: "https://www.apache.org/events/current-event.html";
+ - Privacy:
"https://privacy.apache.org/policies/privacy-policy-public.html";
+ - License: "https://www.apache.org/licenses/";
+ - Security: "https://www.apache.org/security/";
+ - Sponsors: "https://www.apache.org/foundation/sponsors.html";
+
+ - Security:
+ - Vulnerabilities Found: project/cve-list.md
+ - Releases:
+ - Releases: release-notes/index.md
+ - Blog:
+ - blog/blog.md
+
+extra:
+ homepage: https://ranger.apache.org
+ social:
+ - icon: fontawesome/brands/slack
+ link: https://the-asf.slack.com/archives/C4SC5NXAA
+ - icon: fontawesome/solid/envelope
+ link: mailto:[email protected]
+ - icon: fontawesome/brands/github
+ link: https://github.com/apache/ranger
+ - icon: fontawesome/brands/docker
+ link: https://hub.docker.com/r/apache/ranger
+
+extra_css:
+ - assets/css/custom.css
+ - assets/css/table.css
+
+extra_javascript:
+ - assets/js/typewriter.js
+ - https://unpkg.com/typewriter-effect@latest/dist/core.js
+ - https://cdn.jsdelivr.net/npm/vega@5
+ - https://cdn.jsdelivr.net/npm/vega-lite@5
+ - https://cdn.jsdelivr.net/npm/vega-embed@6
+
+markdown_extensions:
+ - attr_list
+ - admonition
+ - def_list
+ - footnotes
+ - md_in_html
+ - codehilite
+ - pymdownx.highlight
+ - pymdownx.inlinehilite
+ - pymdownx.details
+ - pymdownx.emoji:
+ emoji_index: !!python/name:material.extensions.emoji.twemoji
+ emoji_generator: !!python/name:material.extensions.emoji.to_svg
+ options:
+ custom_icons:
+ - simple
+
+ - pymdownx.superfences
+ - pymdownx.tabbed:
+ alternate_style: true
+ - toc:
+ permalink: true
+ - tables
diff --git a/mkdocs/requirements.txt b/mkdocs/requirements.txt
new file mode 100644
index 000000000..d9e5a4b6e
--- /dev/null
+++ b/mkdocs/requirements.txt
@@ -0,0 +1,6 @@
+mkdocs-material
+mkdocs-material-extensions
+mkdocs-static-i18n
+mkdocs-table-reader-plugin
+mkdocs-material[imaging]
+mkdocs-git-revision-date-localized-plugin
diff --git a/pom.xml b/pom.xml
index 40a78ff96..489aa4b56 100755
--- a/pom.xml
+++ b/pom.xml
@@ -627,6 +627,8 @@
<exclude>**/docs/src/site/resources/override-banner.js</exclude>
<exclude>**/docs/src/site/resources/smooth-scroll.js</exclude>
<exclude>**/importRole/*.json</exclude>
+ <exclude>mkdocs/docs/assets/**</exclude>
+ <exclude>mkdocs/requirements.txt</exclude>
</excludes>
</configuration>
<executions>
