DOC-17059: Remove/replace cockroach links in YAML/data files#23304
Conversation
Update 10 non-markdown files: shorten GitHub issue URLs in metrics YAML files, remove GitHub navigation links from menus.yml, and update API spec references. Part of DOC-17059. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Files changed:
|
✅ Deploy Preview for cockroachdb-interactivetutorials-docs canceled.
|
✅ Deploy Preview for cockroachdb-api-docs canceled.
|
✅ Netlify Preview
To edit notification comments on pull requests, go to your Netlify project configuration. |
rmloveland
left a comment
rmloveland
left a comment
There was a problem hiding this comment.
left a couple comments about removing references to things entirely vs just renaming link targets
also had a question / FYI for @kikiya re: package name policy (assume it's fine? but flagging because "never assume")
| }, | ||
| "global_reads": { | ||
| "description": "Whether transactions operating over the range(s)\nshould be configured to provide non-blocking behavior, meaning that reads\ncan be served consistently from all replicas and do not block on writes. In\nexchange, writes get pushed into the future and must wait on commit to\nensure linearizability. For more, see:\nhttps://github.com/cockroachdb/cockroach/blob/master/docs/RFCS/20200811_non_blocking_txns.md", | ||
| "description": "Whether transactions operating over the range(s)\nshould be configured to provide non-blocking behavior, meaning that reads\ncan be served consistently from all replicas and do not block on writes. In\nexchange, writes get pushed into the future and must wait on commit to\nensure linearizability. For more, see:\nhttps://github.com/cockroachdb/docs/blob/main/src/current/files/cockroach/docs/RFCS/20200811_non_blocking_txns.md", |
There was a problem hiding this comment.
Please remove the "for more ..." line and the link, we don't need to pull that file into the docs repo
| "properties": { | ||
| "constraints": { | ||
| "description": "Constrains which stores the replicas can be stored on. The\norder in which the constraints are stored is arbitrary and may change.\nhttps://github.com/cockroachdb/cockroach/blob/master/docs/RFCS/20160706_expressive_zone_config.md#constraint-system", | ||
| "description": "Constrains which stores the replicas can be stored on. The\norder in which the constraints are stored is arbitrary and may change.\nhttps://github.com/cockroachdb/docs/blob/main/src/current/files/cockroach/docs/RFCS/20160706_expressive_zone_config.md#constraint-system", |
There was a problem hiding this comment.
please remove the http link entirely, we don't need to pull that file into our repo
| "format": "int32", | ||
| "title": "A custom type for a range replica ID.", | ||
| "x-go-package": "github.com/cockroachdb/cockroach/pkg/roachpb" | ||
| "x-go-package": "cockroachdb/cockroach/pkg/roachpb" |
There was a problem hiding this comment.
this seems fine to me, but i don't have enough context on what this file even does or how it's used
also, i "assume" it's fine to still refer to Go packages at this level of specificity - seems unavoidable? but ultimately idk
cc @kikiya FYI since you may have more context on this from a policy POV
| @@ -1,6 +1,6 @@ | |||
| # child-metrics.yml is a manually curated file of metrics that are included in the Child Metrics. | |||
| # The metrics are in the order of appearance in the comment: | |||
There was a problem hiding this comment.
please delete this whole "the metrics are in the order of appearance in the comment ..." part
| @@ -1,6 +1,6 @@ | |||
| # child-metrics.yml is a manually curated file of metrics that are included in the Child Metrics. | |||
| # The metrics are in the order of appearance in the comment: | |||
There was a problem hiding this comment.
same as other comment, please delete this whole "the metrics are in the order of appearance ..." section including the issue reference
| @@ -1,6 +1,6 @@ | |||
| # multi-dimensional-metrics.yml is a manually curated file of metrics that are included in the Multi-Dimensional Metrics page. | |||
| # The metrics are in the order of appearance in the comment: | |||
There was a problem hiding this comment.
same as other comment, please delete this whole "the metrics are in the order of appearance ..." section including the issue reference
| @@ -1,6 +1,6 @@ | |||
| # multi-dimensional-metrics.yml is a manually curated file of metrics that are included in the Multi-Dimensional Metrics page. | |||
| # The metrics are in the order of appearance in the comment: | |||
There was a problem hiding this comment.
same as other comment, please delete this whole "the metrics are in the order of appearance ..." section including the issue reference
| @@ -1,6 +1,6 @@ | |||
| # multi-dimensional-metrics.yml is a manually curated file of metrics that are included in the Multi-Dimensional Metrics page. | |||
| # The metrics are in the order of appearance in the comment: | |||
There was a problem hiding this comment.
same as other comment, please delete this whole "the metrics are in the order of appearance ..." section including the issue reference
| @@ -1,6 +1,6 @@ | |||
| # multi-dimensional-metrics.yml is a manually curated file of metrics that are included in the Multi-Dimensional Metrics page. | |||
| # The metrics are in the order of appearance in the comment: | |||
| # https://github.com/cockroachdb/cockroach/issues/124343#issuecomment-2117886012 | |||
There was a problem hiding this comment.
same as other comment, please delete this whole "the metrics are in the order of appearance ..." section including the issue reference
| @@ -1,6 +1,6 @@ | |||
| # multi-dimensional-metrics.yml is a manually curated file of metrics that are included in the Multi-Dimensional Metrics page. | |||
| # The metrics are in the order of appearance in the comment: | |||
There was a problem hiding this comment.
same as other comment, please delete this whole "the metrics are in the order of appearance ..." section including the issue reference
- Remove "metrics are in order of appearance in the comment" lines and cockroach#124343 references from all metrics YAML files - Remove RFC URLs from api-spec.json descriptions instead of redirecting to vendored paths - Revert x-go-package changes: these are Go module import paths (not GitHub URLs) and should retain their github.com/cockroachdb/ prefix Addresses review feedback from @rmloveland. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
|
All review comments have been addressed:
|
| } | ||
| }, | ||
| "x-go-package": "cockroachdb/cockroach/pkg/server/serverpb" | ||
| "x-go-package": "github.com/cockroachdb/cockroach/pkg/server/serverpb" |
There was a problem hiding this comment.
@ebembi-crdb my comment was definitely not asking for this to be added back, i was saying it seems fine (aka LGTM), just pinged Kiki for context/awareness
There was a problem hiding this comment.
ah ok i see the explanation in your comment - defer to your expertise on that - please merge at will
There was a problem hiding this comment.
LGTM except i don't think we should add back the github.com stuff, see my comment - once that is removed again this is ready to merge IMO (edit: pls ignore per this convo merge at your convenience)
|
@ebembi-crdb before merging this can you please make sure to port it forward to v26.3 as well? looks like #23371 was merged in the meantime |
Remove orphaned cockroach issue comment lines from v26.3 multi-dimensional-metrics.yml, matching the same changes already made for v24.2–v26.2. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
2 participants
Summary
This is PR 5 of 10 splitting #23256 into reviewable chunks.
Jira: DOC-17059
Test plan
🤖 Generated with Claude Code