Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

mkdocs: configure page redirects #874

Merged
merged 1 commit into from
Oct 3, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,5 @@ jobs:
python-version: 3.x
- run: pip3 install mkdocs-material
- run: pip3 install mkdocs-git-revision-date-localized-plugin
- run: pip3 install mkdocs-redirects
- run: mkdocs gh-deploy --force
1 change: 1 addition & 0 deletions admin/how_to_build_docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ See https://squidfunk.github.io/mkdocs-material/getting-started/.
pip3 install mkdocs
pip3 install mkdocs-material
pip3 install mkdocs-git-revision-date-localized-plugin
pip3 install mkdocs-redirects
```

## Build the Docs
Expand Down
14 changes: 14 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,20 @@ plugins:
- search
- git-revision-date-localized:
enable_creation_date: true
- redirects:
redirect_maps:
'auth_actions.md': 'references/authentication/auth_actions.md'
'authentication.md': 'references/authentication/authentication.md'
'authorization.md': 'references/authorization.md'
'banning_users.md': 'user_management/banning_users.md'
'concepts.md': 'getting_started/concepts.md'
'customization.md': 'customization/table_names.md'
'events.md': 'references/events.md'
'forcing_password_reset.md': 'user_management/forcing_password_reset.md'
'install.md': 'getting_started/install.md'
'quickstart.md': 'quick_start_guide/using_session_auth.md'
'session_auth_event_and_logging.md': 'references/authentication/session.md'
'testing.md': 'references/testing.md'
nav:
- Home: index.md
- Getting Started:
Expand Down