docs: clarify member-only profile instructions#41868
docs: clarify member-only profile instructions#41868mbainter wants to merge 1 commit intogithub:mainfrom
Conversation
How to review these changes 👓Thank you for your contribution. To review these changes, choose one of the following options: A Hubber will need to deploy your changes internally to review. Table of review linksNote: Please update the URL for your staging server or codespace. The table shows the files in the
Key: fpt: Free, Pro, Team; ghec: GitHub Enterprise Cloud; ghes: GitHub Enterprise Server 🤖 This comment is automatically generated. |
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.
|
@mbainter I think this is probably a good change, but I'm going to check in to make sure we want it here and dig in a bit to make sure the wording is what we would want it to be. |
|
A stale label has been added to this pull request because it has been open 30 days with no activity. If you think this pull request should remain open, please add a new comment. |
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: