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

Redirect GH Pages docs to ReadTheDocs #3287

Open
agilgur5 opened this issue Jan 4, 2024 · 0 comments
Open

Redirect GH Pages docs to ReadTheDocs #3287

agilgur5 opened this issue Jan 4, 2024 · 0 comments
Labels
docs Needs documentation/release notes enhancement New feature or request

Comments

@agilgur5
Copy link

agilgur5 commented Jan 4, 2024

Summary

As part of argoproj/argo-workflows#11390 (specifically argoproj/argo-workflows#11390 (comment)), I noticed that Rollouts still has a GH Pages docs site up and that it doesn't redirect to RTD.

We should add redirects from GH Pages to RTD, similar to the ones that CD and Workflows have.

Use Cases

  1. Replace all GH Pages docs pages with meta redirects.

  2. Ensure any links to GH Pages are changed to RTD if they haven't already been changed

  3. Remove the "Deploy" step from the GH Pages publish workflow

    • Can also remove the write permissions with that, which is a nice touch for security purposes
    • Could remove the entire gh-pages.yaml workflow as it appears to only run on master builds.
      • I would suggest still running it during CI on PRs so that PRs must pass the docs build. It seems to not be running on PRs right now.
      • Also should pin the versions of the docs build tools for consistent builds and security purposes. Here's Workflows's minimal pin

Message from the maintainers:

Impacted by this bug? Give it a 👍. We prioritize the issues with the most 👍.

@agilgur5 agilgur5 added enhancement New feature or request docs Needs documentation/release notes labels Jan 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Needs documentation/release notes enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant