-
Notifications
You must be signed in to change notification settings - Fork 467
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
remove self
nodelocal examples
#17979
Conversation
✅ 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 site configuration. |
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.
LGTM, as per the PR description the only mention of self
remains in the footnote to the main table on this page.
I agree with taking this out of the examples, but I worry the footnote is still too hard to find, and in particular the note about "common bucket" not super-discoverable. What do you two think of that? Is it fine? Or is there a way we can make it a teeny bit more prominent? |
Depending on how we feel about customers using Nodelocal, (I don't have a good understanding of this), we could just put the footnote into the David, let me know if you want me make any changes. |
That seems fine, to me, as long as finding it is the only way you'd ever discover We want -- nay, need -- you to find the footnote and read it if you're going to use |
|
Correct, I think |
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.
OK, I like it!
ed6fda8
to
57ba2cd
Compare
@dt do you want to remove these examples from v23.2 docs as well? |
We do not recommend `self` in most cases and showing it as an example gives it more exposure than we really desire. We especially want to be sure that anyone using "self" has read and understood the footnote under "considerations". This note was previously linked after the example but that relied on one clicking it and reading it, so a user could presumably discover and start using `self` without reading the note. After this change, the only mention of `self` is in the footnote, so only users who read the note should be aware it is an option, specifically in the configuration where it is a valid option.
11a1b1c
to
9608e09
Compare
We do not recommend
self
in most cases and showing it as an example gives it more exposure than we really desire.We especially want to be sure that anyone using "self" has read and understood the footnote under "considerations". This note was previously linked after the example but that relied on one clicking it and reading it, so a user could presumably discover and start using
self
without reading the note.After this change, the only mention of
self
is in the footnote, so only users who read the note should be aware it is an option, specifically in the configuration where it is a valid option.