-
Notifications
You must be signed in to change notification settings - Fork 472
Create public preview docs for new Kubernetes operator #19942
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
base: main
Are you sure you want to change the base?
Conversation
✅ Deploy Preview for cockroachdb-interactivetutorials-docs canceled.
|
✅ Deploy Preview for cockroachdb-api-docs canceled.
|
|
||
## Disable auto-finalization | ||
|
||
{% include common/upgrade/disable-auto-finalization.md %} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is not rendering like it should, unsure why. The needed version of the include content can be found here: https://docs.google.com/document/d/196HI1b1QSbyDGtLPT3FF8rbNeMVdOZBCMyQ7UKdbK8k/edit?tab=t.k5y17crpdkaz#heading=h.144douprth3q
@mikeCRL can you take a look?
❌ Deploy Preview for cockroachdb-docs failed. Why did it fail? →
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is quite a lot of work -- apologies for taking a while on the review.
I have a lot of suggested edits here, but am blocking for the following:
- (Obviously, as you mentioned) Still needs the operator overview doc, and the Preview callout.
- Markdown formatting doesn't match our docs set, as we discussed already.
- Similarly, some style-related notes on capitalization, use of "we" in tutorials, etc.
- Related: Code and output snippets should be presented cleanly and consistently with how we use them in the docs (see my notes).
- In the guidance, some example yaml is missing where it would greatly help clarity. In particular, the instructions in
deploy-cockroachdb-with-kubernetes-operator
on configuring locality are confusing to me. I think these parts can be tightened up. - The two migration docs should more clearly emphasize that they aren't for prod deployments.
- Ensure the "informal" product terminology for the new vs. old operator is consistent throughout.
Otherwise, I took the time to make suggested rewrites, but some of the copy feels more conversational than is helpful (especially in kubernetes-operator-performance
). This isn't a blocking comment per se, and a conversational tone can be nice with such a complicated topic. But at times (in the performance doc, and with the locality stuff I mentioned above), I think it obfuscates the guidance itself. Let me know if you want to discuss. I also replaced passive with active language where I saw it.
src/current/_includes/v25.2/sidebar-data/self-hosted-deployments.json
Outdated
Show resolved
Hide resolved
src/current/_includes/v25.2/sidebar-data/self-hosted-deployments.json
Outdated
Show resolved
Hide resolved
src/current/_includes/v25.2/sidebar-data/self-hosted-deployments.json
Outdated
Show resolved
Hide resolved
src/current/_includes/v25.2/sidebar-data/self-hosted-deployments.json
Outdated
Show resolved
Hide resolved
Applying batch suggestions from Ryan's review in github Co-authored-by: Ryan Kuo <[email protected]>
TODO:
REQUEST FOR REVIEW
shell
syntax highlighting is unhelpful (only the first line gets a$
prompt, all other lines with prompts are ignored)