Skip to content

Commit 280b8f1

Browse files
authored
Merge pull request #874 from kenjis/docs-mkdocs-redirect
mkdocs: configure page redirects
2 parents e3ab1ac + 0b05a96 commit 280b8f1

File tree

3 files changed

+16
-0
lines changed

3 files changed

+16
-0
lines changed

.github/workflows/docs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,4 +15,5 @@ jobs:
1515
python-version: 3.x
1616
- run: pip3 install mkdocs-material
1717
- run: pip3 install mkdocs-git-revision-date-localized-plugin
18+
- run: pip3 install mkdocs-redirects
1819
- run: mkdocs gh-deploy --force

admin/how_to_build_docs.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ See https://squidfunk.github.io/mkdocs-material/getting-started/.
1414
pip3 install mkdocs
1515
pip3 install mkdocs-material
1616
pip3 install mkdocs-git-revision-date-localized-plugin
17+
pip3 install mkdocs-redirects
1718
```
1819

1920
## Build the Docs

mkdocs.yml

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,20 @@ plugins:
8080
- search
8181
- git-revision-date-localized:
8282
enable_creation_date: true
83+
- redirects:
84+
redirect_maps:
85+
'auth_actions.md': 'references/authentication/auth_actions.md'
86+
'authentication.md': 'references/authentication/authentication.md'
87+
'authorization.md': 'references/authorization.md'
88+
'banning_users.md': 'user_management/banning_users.md'
89+
'concepts.md': 'getting_started/concepts.md'
90+
'customization.md': 'customization/table_names.md'
91+
'events.md': 'references/events.md'
92+
'forcing_password_reset.md': 'user_management/forcing_password_reset.md'
93+
'install.md': 'getting_started/install.md'
94+
'quickstart.md': 'quick_start_guide/using_session_auth.md'
95+
'session_auth_event_and_logging.md': 'references/authentication/session.md'
96+
'testing.md': 'references/testing.md'
8397
nav:
8498
- Home: index.md
8599
- Getting Started:

0 commit comments

Comments
 (0)