docs: Add sphinxext.rediraffe redirection plugin#13436
docs: Add sphinxext.rediraffe redirection plugin#13436mattklein123 merged 1 commit intoenvoyproxy:masterfrom
Conversation
|
trying to figure out how the actual docs site is built - sphinx is building in given above im reasonably confident that this should fix the redirect problems in #11068 but i cant test 100% until we see it published |
Signed-off-by: Ryan Northey <ryan@synca.io>
81b60d0 to
a9c0592
Compare
|
/retest-circle |
|
🔨 rebuilding |
|
To run rediraffecheckdiff on PR's, you just need to have both the pr and master available. From their ci: check-redirects:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Checkout master
run: |
git fetch origin master --depth=1
- uses: actions/setup-python@v2
with:
python-version: 3.7
- name: Install Dependencies
run: |
pip install -r source/requirements.txt
- name: Check redirects
run: |
make rediraffecheckdiff |
|
thanks @TheTripleV thats really helpful |
mattklein123
left a comment
There was a problem hiding this comment.
Very cool. Is this something you want to merge right now? Or do you want to wire up more automation?
/wait-any
|
i think if we can land it now, it means we can start moving things without breaking anything. once we have it landed, i can look at hooking up CI |
Signed-off-by: Ryan Northey ryan@synca.io
Commit Message: docs: Add sphinxext.rediraffe redirection plugin
Additional Description:
Adds a Sphinx extension that allows redirecting pages that have been moved, to ensure that old published links continue to work when docs change
Also has a tool for diffing against commit/branch to figure out which redirects should be added. This could potentially be added as part of CI, but i have not done so in this PR, as just fixing the links and adding the redirects seemed a greater priority.
Of the options i looked at this extension seemed to have the most active dev, and has the bonus feature of the diff tool
Risk Level:
Testing:
Docs Changes:
Release Notes:
[Optional Runtime guard:]
[Optional Fixes #Issue] Fix #11068 touch #13386
[Optional Deprecated:]
refs