Skip to content

Conversation

@rmloveland
Copy link
Contributor

@rmloveland rmloveland commented Oct 9, 2025

Fixes DOC-12942

NB. This change is ported to all supported versions v24.1 and later

@netlify
Copy link

netlify bot commented Oct 9, 2025

Deploy Preview for cockroachdb-api-docs canceled.

Name Link
🔨 Latest commit daa28ec
🔍 Latest deploy log https://app.netlify.com/projects/cockroachdb-api-docs/deploys/68ee707cb574180008016e06

@netlify
Copy link

netlify bot commented Oct 9, 2025

Deploy Preview for cockroachdb-interactivetutorials-docs canceled.

Name Link
🔨 Latest commit daa28ec
🔍 Latest deploy log https://app.netlify.com/projects/cockroachdb-interactivetutorials-docs/deploys/68ee707c97faa4000886c332

@github-actions
Copy link

github-actions bot commented Oct 9, 2025

@netlify
Copy link

netlify bot commented Oct 9, 2025

Netlify Preview

Name Link
🔨 Latest commit daa28ec
🔍 Latest deploy log https://app.netlify.com/projects/cockroachdb-docs/deploys/68ee707cfaa14600082d00c0
😎 Deploy Preview https://deploy-preview-20523--cockroachdb-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Copy link
Contributor

@bsanchez-the-roach bsanchez-the-roach left a comment

Choose a reason for hiding this comment

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

One small observation, just a detail to consider.

So this change makes it so that the link takes you to the "Enable Super Regions" section of the Alter Database page.

When linking from this page (https://www.cockroachlabs.com/docs/v24.1/multiregion-overview) that seems like a good thing.

When linking from this page, though (https://www.cockroachlabs.com/docs/v24.1/show-super-regions) maybe that's not ideal, because there's actually an "Enable Super Regions" heading on this page itself, and maybe the more intuitive link is to the occurrence of that "Enable Super Regions" section on this same page.

Or maybe it doesn't matter.

I'm being very very nitpicky here but it's something to consider.

Updated link with conditional logic based on page
@rmloveland
Copy link
Contributor Author

When linking from this page, though (https://www.cockroachlabs.com/docs/v24.1/show-super-regions) maybe that's not ideal, because there's actually an "Enable Super Regions" heading on this page itself, and maybe the more intuitive link is to the occurrence of that "Enable Super Regions" section on this same page.

Ah good point, thanks! I have changed the text slightly so it uses Jekyll's templating language Liquid to conditionally link to the anchor on the 'SHOW SUPER REGIONS' page, otherwise link to the one on the ALTER DATABASE page

if you haven't used this before, i wrote up a little internal wiki page on it here

please take a look and let me know what you think!

@rmloveland rmloveland enabled auto-merge (squash) October 14, 2025 15:47
@rmloveland rmloveland merged commit 23a7eec into main Oct 14, 2025
6 checks passed
@rmloveland rmloveland deleted the 20251009-DOC-12942-update-super-region-links branch October 14, 2025 16:14
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.

2 participants