docs: Revamp info on how to add a new hub #498
Conversation
yuvipanda
requested review from
GeorgianaElena,
choldgraf,
damianavila and
sgibson91
There was a problem hiding this comment.
Just love it! 🎉
I noticed that opening up a new GitHub issue is not in the steps anymore. Not sure if this was the intention, but I think we should keep it, since it helps us organize :D Maybe add a note abut it at the end to instruct ticking the right boxes after the hub was added, or open a new issue if one wasn't opened already?
There was a problem hiding this comment.
This is really great and very helpful for people like me who have not deployed a ton of hubs :-). I added in a few comments about extra information / context we might want to add. Happy to iterate on this a bit more!
Note that this may also close 2i2c-org/team-compass#128
| @@ -1,8 +1,67 @@ | |||
| # Add a new hub | |||
|
|
|||
| Adding a new hub requires that we do three things: | |||
| ## Step 1: Decide where the hub will live | |||
There was a problem hiding this comment.
| ## Step 1: Decide where the hub will live | |
| ## Step 0: Open a GitHub issue | |
| In order to track progress on deploying the new hub, [open a GitHub issue in the `support/` repository](https://github.com/2i2c-org/support/issues/new/choose). | |
| Make sure to choose the `new-hub` issue template. | |
| ## Step 1: Decide where the hub will live |
There was a problem hiding this comment.
per @GeorgianaElena's comment, I've created an empty support/ repo that we can start to modify to suit our support processes. For creating a hub, how about the text above + we create an issue template for creating a new hub that has a checklist corresponding to each of the steps here?
There was a problem hiding this comment.
I incorporated this, but pointing to pilot-hubs still. 2i2c-org/team-compass#151 talks about the support/ repository.
There was a problem hiding this comment.
I think that is OK for now, @choldgraf?
|
|
||
| ## Step 4: Decide the authentication provider to be used | ||
|
|
||
| In consultation with the users, decide |
There was a problem hiding this comment.
On this page, perhaps we should define a Community Champion role for a hub (or maybe we should re-name this "user representative"?) and then suggest that we ask this person questions throughout the process, rather than to use a generic "user" identity like here? I'd like us to move away from the possibility that multiple users on a hub might be needed to answer questions.
There was a problem hiding this comment.
I'd like us to move away from the possibility that multiple users on a hub might be needed to answer questions.
💯
There was a problem hiding this comment.
@choldgraf, until we have the Community champion role well defined, I think this is OK for now. Let us know if you disagree.
Is also a jumping off point for other things that need to be better documented.
Co-authored-by: Chris Holdgraf <choldgraf@gmail.com>
yuvipanda
force-pushed
the
add-new-hub-docs
branch
from
340f4f6
to
32c9bb0
Compare
| @@ -1,8 +1,67 @@ | |||
| # Add a new hub | |||
|
|
|||
| Adding a new hub requires that we do three things: | |||
| ## Step 1: Decide where the hub will live | |||
There was a problem hiding this comment.
I incorporated this, but pointing to pilot-hubs still. 2i2c-org/team-compass#151 talks about the support/ repository.
Is also a jumping off point for other things that need
to be better documented.