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

Rework how redirects are organized and deployed #34

Open
abadger opened this issue Sep 25, 2020 · 0 comments
Open

Rework how redirects are organized and deployed #34

abadger opened this issue Sep 25, 2020 · 0 comments

Comments

@abadger
Copy link
Contributor

abadger commented Sep 25, 2020

We have several classes of redirects for the docsite which live in several different files. It makes it hard to see what's going on sometimes and can make it harder to track down what is going on when there are conflicts between several redirects. After talking with shanemcd and acozine (with input from gmainwaring), we think we have a plan for better organizing this:

  • In the docsite repo, have a set of redirects in multiple files organized by what type they are (legacy redirects from the docs reorg in dharmabumstead's time, module and plugin redirects for the 2.9<=>2.10 transition, etc). These can be reviewed and managed by the docs team.
    • The goal of this organization is to make it easy to review the redirects for problems. A problem might be reported as "collections/ansible/builtin/ping_module.html is being redirected to does/not/exist.html which is a 404". We'd want the reorg to make it easier to grep for the files being redirected and to make it easier to tell which proto-htacces files are involved in redirecting for a particular path. In particular, knowing which files contain global redirects and which are targeting specific files will be helpful.
  • Have a script or ansible playbook which can template those separate files into a single .htaccess file that lives in an upper level of the docs server.
  • Modify the docsite jenkins job to run the playbook/script from the docsite git repo and then copy the built .htaccess file into the right place.

Note that we probably still need some per-directory .htaccess files to do things like turn MultiViews off only for a certain subdirectory but this reorganization should be able to consolidate all of the redirects to make them easier to manage.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant