Add zone config troubleshooting guide #19283
Draft
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for cockroachdb-api-docs canceled.
|
✅ Deploy Preview for cockroachdb-interactivetutorials-docs canceled.
|
❌ Deploy Preview for cockroachdb-docs failed. Why did it fail? →
|
rmloveland
force-pushed
the
20241209-DOC-9210-zone-config-troubleshooting-guide
branch
7 times, most recently
from
e8df32a to
674915d
Compare
rmloveland
force-pushed
the
20241209-DOC-9210-zone-config-troubleshooting-guide
branch
6 times, most recently
from
e11a980 to
d460824
Compare
Fixes DOC-9210 Summary of changes: - Add a new page, 'Troubleshoot Replication Zones', to _The ZoneConfigonomicon (tm)_ - Update the 'Replication controls' page with more detailed info re: zone config inheritance hierarchy and behavior - Fix incorrect statements on the `ALTER RANGE` page since they're needed to map from range IDs returned by the critical nodes endpoint (mentioned in 'Troubleshoot Replication Zones') to actual schema objects - Add moar links (tm) from various zone config-related pages to the new troubleshooting guide and amongst themselves - Add a note to various zone config-related docs saying "most users should not do manual zone config changes, see Multi-region SQL and Zone Config Extensions instead"
rmloveland
force-pushed
the
20241209-DOC-9210-zone-config-troubleshooting-guide
branch
from
d460824 to
8411383
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add zone config troubleshooting guide v1
Fixes DOC-9210
Summary of changes:
Add a new page, 'Troubleshoot Replication Zones', to The
ZoneConfigonomicon (tm)
Update the 'Replication controls' page with more detailed info re:
zone config inheritance hierarchy and behavior
Fix incorrect statements on the
ALTER RANGEpage since they'reneeded to map from range IDs returned by the critical nodes
endpoint (mentioned in 'Troubleshoot Replication Zones') to actual
schema objects
Add moar links (tm) from various zone config-related pages to the new
troubleshooting guide and amongst themselves
Add a note to various zone config-related docs saying "most users
should not do manual zone config changes, see Multi-region SQL and
Zone Config Extensions instead"