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.

Sign up for GitHub

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

Jump to bottom

Migrate to new RTD redirect format #8707

Merged
merged 1 commit into from
Jan 16, 2024
Merged

Migrate to new RTD redirect format #8707

merged 1 commit into from
Jan 16, 2024

Conversation

bensze01
Copy link
Contributor

@bensze01 bensze01 commented Jan 16, 2024 •
edited
Loading

Description

Migrate to the new redirect format introduced by ReadTheDocs in readthedocs/readthedocs.org#10881

The redirect format is described in full here

PR checklist

Please tick as appropriate and edit the reasons (e.g.: "backport: not needed because this is a new feature")

  • changelog Not required - no user facing changes
  • backport Not required - redirections are only updated in the development branch
  • tests not required - no library changes

@bensze01
Migrate to new RTD redirect format
333ca8f 
Migrate to the new redirect format introduced by ReadTheDocs in
readthedocs/readthedocs.org#10881

Signed-off-by: Bence Szépkúti <[email protected]>
@bensze01 bensze01 added bug needs-review Every commit must be reviewed by at least two team members, component-docs Docs / website issues filed here for tracking needs-reviewer This PR needs someone to pick it up for review priority-high High priority - will be reviewed soon size-xs Estimated task size: extra small (a few hours at most) labels Jan 16, 2024
davidhorstmann-arm
davidhorstmann-arm approved these changes Jan 16, 2024
View reviewed changes
Copy link
Contributor

@davidhorstmann-arm davidhorstmann-arm left a comment

Choose a reason for hiding this comment

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

LGTM, thanks!

gilles-peskine-arm
gilles-peskine-arm approved these changes Jan 16, 2024
View reviewed changes
Copy link
Contributor

@gilles-peskine-arm gilles-peskine-arm left a comment

Choose a reason for hiding this comment

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

Looks good to me on code inspection, per readthedocs/readthedocs.org#10881 . I haven't validated that it has the desired effect; I'm not sure what I should check, or whether Mbed-TLS/mbedtls-docs#129 needs to be merged first.

@gilles-peskine-arm gilles-peskine-arm added approved Design and code approved - may be waiting for CI or backports and removed needs-review Every commit must be reviewed by at least two team members, needs-reviewer This PR needs someone to pick it up for review labels Jan 16, 2024
@davidhorstmann-arm
Copy link
Contributor

I'm not sure what I should check, or whether Mbed-TLS/mbedtls-docs#129 needs to be merged first.

The main and versioned docs are independent projects (and therefore independent builds) so merge order doesn't matter.

@bensze01
Copy link
Contributor Author

@gilles-peskine-arm The way I tested the change was

  1. Create a personal RTD access token here
  2. Install readthedocs-cli
  3. Run RTD_TOKEN=<token> rtd projects "Mbed TLS API" redirects to list the redirections automigrated by ReadTheDocs
  4. Run RTD_TOKEN=<token> rtd projects "Mbed TLS API" redirects sync --dry-run -f docs/redirects.yaml to verify the new config file produces equivalent results to the automigration.
  5. Run curl -I https://mbed-tls.readthedocs.io/projects/api/en/latest/api/filelist/ to see if the redirect works.

@bensze01 bensze01 enabled auto-merge January 16, 2024 18:04
@bensze01 bensze01 added this pull request to the merge queue Jan 16, 2024
Merged via the queue into Mbed-TLS:development with commit 1325942 Jan 16, 2024
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@gilles-peskine-arm gilles-peskine-arm gilles-peskine-arm approved these changes

@davidhorstmann-arm davidhorstmann-arm davidhorstmann-arm approved these changes

Assignees
No one assigned
Labels
approved Design and code approved - may be waiting for CI or backports bug component-docs Docs / website issues filed here for tracking priority-high High priority - will be reviewed soon size-xs Estimated task size: extra small (a few hours at most)
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@bensze01 @davidhorstmann-arm @gilles-peskine-arm