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

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

Merged
merged 1 commit into from
Nov 3, 2023
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 9 additions & 3 deletions config/redirects
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -212,10 +212,10 @@ raw: docs/drivers/drivers/go/ -> ${base}/go/current/
raw: docs/drivers/drivers/java/ -> ${base}/java-drivers/
raw: docs/drivers/drivers/kotlin/ -> ${base}/kotlin-drivers/
raw: docs/drivers/drivers/node/ -> $${base}/node/current/
raw: docs/drivers/drivers/php/ -> ${base}/php/
raw: docs/drivers/drivers/python/ -> ${base}/python/
raw: docs/drivers/drivers/php/ -> ${base}/php-drivers/
raw: docs/drivers/drivers/python/ -> ${base}/python-drivers/
Comment on lines +215 to +216
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 •
edited
Loading

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?

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.

raw: docs/drivers/drivers/ruby/ -> ${base}/ruby-drivers/
raw: docs/drivers/drivers/rust/ -> ${base}/rust/current/
raw: docs/drivers/drivers/scala/ -> ${base}/scala/
raw: docs/drivers/drivers/swift/ -> ${base}/swift/
Expand All @@ -226,3 +226,9 @@ raw: docs/drivers/drivers/driver-compatibility-reference -> ${base}/
# Redirect for outdated Community Drivers page

raw: docs/drivers/community-supported-drivers/ -> ${base}/

# Redirects for consistent language-spcific driver landing pages

raw: docs/drivers/php/ -> ${base}/php-drivers/
raw: docs/drivers/python/ -> ${base}/python-drivers/
raw: docs/drivers/ruby/ -> ${base}/ruby-drivers/
2 changes: 1 addition & 1 deletion snooty.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name = "drivers"
title = "MongoDB Drivers"

toc_landing_pages = ["/python", "/php", "/java-drivers", "/kotlin-drivers", "/use-cases", "/ruby"]
toc_landing_pages = ["/python-drivers", "/php-drivers", "/java-drivers", "/kotlin-drivers", "/use-cases", "/ruby-drivers"]

intersphinx = ["https://www.mongodb.com/docs/manual/objects.inv"]
sharedinclude_root = "https://raw.githubusercontent.com/10gen/docs-shared/main/"
Expand Down
12 changes: 6 additions & 6 deletions source/index.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,19 +67,19 @@ security patches to them.

.. card::
:headline: PHP
:url: /php/
:url: /php-drivers/
:icon: /icons/php.svg
:icon-alt: PHP Driver icon

.. card::
:headline: Python
:url: /python/
:url: /python-drivers/
:icon: /icons/python.svg
:icon-alt: Python Driver icon

.. card::
:headline: Ruby
:url: /ruby/
:url: /ruby-drivers/
:icon: /icons/ruby.svg
:icon-alt: Ruby Driver icon

Expand Down Expand Up @@ -152,9 +152,9 @@ Don’t see your desired language? Browse more `community-supported libraries <h
Java Drivers </java-drivers>
Kotlin Drivers </kotlin-drivers>
Node.js Driver <https://www.mongodb.com/docs/drivers/node/current/>
PHP Driver </php>
Python Drivers </python>
Ruby Drivers </ruby>
PHP Driver </php-drivers>
Python Drivers </python-drivers>
Ruby Drivers </ruby-drivers>
Rust Driver <https://www.mongodb.com/docs/drivers/rust/current/>
Scala Driver </scala>
Swift Driver </swift>
Expand Down
0 source/php.txt → source/php-drivers.txt
View file
Open in desktop
File renamed without changes.
0 source/python.txt → source/python-drivers.txt
View file
Open in desktop
File renamed without changes.
0 source/ruby.txt → source/ruby-drivers.txt
View file
Open in desktop
File renamed without changes.
Loading