-
Notifications
You must be signed in to change notification settings - Fork 614
Extension for Ansible redirects #2418
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
base: devel
Are you sure you want to change the base?
Conversation
37aaddd
to
59a6df2
Compare
59a6df2
to
c5ec601
Compare
768cd3f
to
1e48ae3
Compare
1e48ae3
to
5641adf
Compare
5641adf
to
97be9ad
Compare
97be9ad
to
acdbce4
Compare
23a442d
to
09a7683
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
Co-authored-by: 🇺🇦 Sviatoslav Sydorenko (Святослав Сидоренко) <[email protected]>
Co-authored-by: 🇺🇦 Sviatoslav Sydorenko (Святослав Сидоренко) <[email protected]>
Co-authored-by: 🇺🇦 Sviatoslav Sydorenko (Святослав Сидоренко) <[email protected]>
Co-authored-by: 🇺🇦 Sviatoslav Sydorenko (Святослав Сидоренко) <[email protected]>
Co-authored-by: 🇺🇦 Sviatoslav Sydorenko (Святослав Сидоренко) <[email protected]>
Co-authored-by: 🇺🇦 Sviatoslav Sydorenko (Святослав Сидоренко) <[email protected]>
09a7683
to
910c941
Compare
@webknjaz / @felixfontein / @gotmax23 Could we please get another round of reviews here? I've added all the redirects to the ReadTheDocs project and this PR is one of the last hurdles in the way of the |
if: env.REDIRECTS == 'true' | ||
run: >- | ||
make webdocs EXTRA_TAGS="-t redirects" ANSIBLE_VERSION="${{ | ||
env.PACKAGE_VERSION != 'devel' && env.PACKAGE_VERSION || '' | ||
}}" | ||
working-directory: build-directory/docs/docsite | ||
|
||
- name: Build the Ansible community package docs | ||
if: env.REDIRECTS == 'false' |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
if: env.REDIRECTS == 'true' | |
run: >- | |
make webdocs EXTRA_TAGS="-t redirects" ANSIBLE_VERSION="${{ | |
env.PACKAGE_VERSION != 'devel' && env.PACKAGE_VERSION || '' | |
}}" | |
working-directory: build-directory/docs/docsite | |
- name: Build the Ansible community package docs | |
if: env.REDIRECTS == 'false' |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@webknjaz I believe this should be conditional based on the inputs. For some builds, such as deploying to gh-pages, you probably don't want to generate redirects.
Also if we remove the condition here, shouldn't we remove the generate-redirects
input?
Co-authored-by: 🇺🇦 Sviatoslav Sydorenko (Святослав Сидоренко) <[email protected]>
Fixes #2147 and supercedes #2266
This PR extends the Sphinx reredirects extension to load redirects for Ansible documentation from a toml file. The purpose is to replace the httpd mod_rewrite rules in https://github.com/ansible/docsite/blob/main/ansible/11/.htaccess and https://github.com/ansible/docsite/blob/main/.htaccess in a way that is compatible with ReadTheDocs.
If this PR is accepted and merged, there are two follow on actions:
robots.txt
file to stop crawlers from indexing the generated HTML files. We can put therobots.txt
file in theansible/docsite
repo and copy it across as part of the ReadTheDocs build.docs/docsite/rst/user_guide
folder.