docs: clarify member-only profile instructions #41868
Open
+2
−0
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.
Why:
The docs do specify a private repository already, but this adds a callout to emphasize that this doesn't mean "not public" but rather that it has to have visibility of private -- internal is not enough. It can be easy to think of internal as a different level of visibility for a private repository instead of a whole other type that affects the way other features interact with it.
Because of how we structure our organization I wanted our .github-private repo to be internal and for a while I could not figure out why the org profile wasn't showing. Since we had also moved to Enterprise Managed Users I defaulted to assuming it was connected to EMU and glossed over the visibility as a factor. Trying to do searches when troubleshooting this problem also didn't yield helpful results, partly because I assumed it was connected to EMUs. I almost moved on once I figured it out, but I suspect maybe I'm not the first or the last to be bitten by this. I figure worst case people searching on it might land here.
I also considered rewording the documentation itself, but I think this is more a problem of ensuring people have the right mental modal for private vs internal. I don't know if that has the same impact anywhere else, so a small callout to help people avoid making my mistake seemed like the best solution to me.
What's being changed (if available, include any code snippets, screenshots, or gifs):
Adding a callout to the member-only profile instructions
Check off the following: