Skip to content

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

Open
wants to merge 15 commits into
base: devel
Choose a base branch
from

Conversation

oraNod
Copy link
Contributor

@oraNod oraNod commented Feb 14, 2025

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:

  • Create a robots.txt file to stop crawlers from indexing the generated HTML files. We can put the robots.txt file in the ansible/docsite repo and copy it across as part of the ReadTheDocs build.
  • Remove all the existing stub files from this repository. For example, all the files under the docs/docsite/rst/user_guide folder.

@oraNod oraNod force-pushed the issue-2147/sphinx-redirects branch from 768cd3f to 1e48ae3 Compare March 7, 2025 14:25
@oraNod oraNod requested a review from webknjaz March 7, 2025 14:34
@oraNod oraNod marked this pull request as ready for review March 7, 2025 14:38
@oraNod oraNod force-pushed the issue-2147/sphinx-redirects branch from 1e48ae3 to 5641adf Compare March 7, 2025 15:52
@oraNod oraNod force-pushed the issue-2147/sphinx-redirects branch from 5641adf to 97be9ad Compare March 7, 2025 17:12
@oraNod oraNod force-pushed the issue-2147/sphinx-redirects branch from 97be9ad to acdbce4 Compare March 11, 2025 14:37
Copy link
Contributor

@samccann samccann left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

oraNod and others added 14 commits April 22, 2025 12:40
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]>
@oraNod oraNod force-pushed the issue-2147/sphinx-redirects branch from 09a7683 to 910c941 Compare April 22, 2025 11:41
@oraNod
Copy link
Contributor Author

oraNod commented Apr 22, 2025

@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 docs.ansible.com migration. Thanks.

Comment on lines +77 to +85
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'
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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'

Copy link
Contributor Author

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]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc builds Relates to building the documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Using stub pages to replace redirects
4 participants