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

Update url paths to include -drivers suffix for consistency #923

Merged
merged 1 commit into from
Nov 3, 2023

Conversation

rachel-mack
Copy link
Contributor

@rachel-mack rachel-mack commented Oct 27, 2023

Pull Request Info

PR Reviewing Guidelines

JIRA - https://jira.mongodb.org/browse/DOCSP-30932
Staging - https://docs-mongodbcom-staging.corp.mongodb.com/drivers/docsworker-xlarge/DOCSP-30932/

Self-Review Checklist

  • Is this free of any warnings or errors in the RST?
  • N/A Did you run a spell-check?
  • N/A Did you run a grammar-check?
  • Are all the links working?

raw: docs/drivers/drivers/pymongo/ -> ${base}/pymongo/
raw: docs/drivers/drivers/ruby/ -> https://www.mongodb.com/docs/ruby-driver/current/
Copy link
Contributor Author

Choose a reason for hiding this comment

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

The first item in the Ruby dropdown menu links to this site.

@rachel-mack rachel-mack marked this pull request as ready for review October 27, 2023 19:44
Comment on lines +215 to +216
raw: docs/drivers/drivers/php/ -> ${base}/php-drivers/
raw: docs/drivers/drivers/python/ -> ${base}/python-drivers/
Copy link
Contributor

Choose a reason for hiding this comment

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

@ccho-mongodb These redirects don't seem to be working. In staging, I still see the old page, which now no longer shows the correct navbar entries. Do these redirects only take effect after deployment?

Copy link
Contributor

@ccho-mongodb ccho-mongodb Oct 30, 2023

Choose a reason for hiding this comment

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

Redirects aren't written to the staging environment, only the production environment. To build confidence that they will work in production, we usually generate the redirects output with mut-redirects, and paste that into the PR. Then, we test them in production once deployed.

Copy link
Contributor

Choose a reason for hiding this comment

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

@rachel-mack The steps for creating redirects are here. Can you follow the steps under Running Tests for Redirects and paste the output into the PR so we can test those links?

@rachel-mack
Copy link
Contributor Author

Here's a diff of mut-redirects output (full txt files attached for reference):

140,141c140,141
< Redirect 301 /docs/drivers/drivers/php/ https://www.mongodb.com/docs/drivers/php/
< Redirect 301 /docs/drivers/drivers/python/ https://www.mongodb.com/docs/drivers/python/
---
> Redirect 301 /docs/drivers/drivers/php/ https://www.mongodb.com/docs/drivers/php-drivers/
> Redirect 301 /docs/drivers/drivers/python/ https://www.mongodb.com/docs/drivers/python-drivers/
143c143
< Redirect 301 /docs/drivers/drivers/ruby/ https://www.mongodb.com/docs/ruby-driver/current/
---
> Redirect 301 /docs/drivers/drivers/ruby/ https://www.mongodb.com/docs/drivers/ruby-drivers/

redirects-new.txt
redirects-orig.txt

Copy link
Contributor

@ccho-mongodb ccho-mongodb left a comment

Choose a reason for hiding this comment

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

Looks mostly good -- I think some redirects are missing because of missing colons. Could you update that and the redirect output diff? Once completed, please ask for a re-review. Thanks!

config/redirects Outdated Show resolved Hide resolved
@rachel-mack
Copy link
Contributor Author

rachel-mack commented Nov 3, 2023

new diff

140,141c140,141
< Redirect 301 /docs/drivers/drivers/php/ https://www.mongodb.com/docs/drivers/php/
< Redirect 301 /docs/drivers/drivers/python/ https://www.mongodb.com/docs/drivers/python/
---
> Redirect 301 /docs/drivers/drivers/php/ https://www.mongodb.com/docs/drivers/php-drivers/
> Redirect 301 /docs/drivers/drivers/python/ https://www.mongodb.com/docs/drivers/python-drivers/
143c143
< Redirect 301 /docs/drivers/drivers/ruby/ https://www.mongodb.com/docs/ruby-driver/current/
---
> Redirect 301 /docs/drivers/drivers/ruby/ https://www.mongodb.com/docs/drivers/ruby-drivers/
148a149,151
> Redirect 301 /docs/drivers/php/ https://www.mongodb.com/docs/drivers/php-drivers/
> Redirect 301 /docs/drivers/python/ https://www.mongodb.com/docs/drivers/python-drivers/
> Redirect 301 /docs/drivers/ruby/ https://www.mongodb.com/docs/drivers/ruby-drivers/

redirects-new.txt

Copy link
Contributor

@ccho-mongodb ccho-mongodb left a comment

Choose a reason for hiding this comment

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

LGTM!
Let me know if you want to pair on checking that the published version works as intended.

@rachel-mack rachel-mack merged commit 5b1377b into mongodb:master Nov 3, 2023
1 check passed
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

Successfully merging this pull request may close these issues.

3 participants