docs: enhance quick start with lessons learned #15900
Conversation
gu-stav
changed the title
is that correct? |
|
@sndrs it's one of the things we did though I don't know what would happen if we didn't do it...
|
| @@ -25,7 +25,7 @@ Follow [this link](https://www.google.co.uk) and enter the relevant search strin | |||
|
|
|||
| # Local Test Server setup | |||
|
|
|||
| You can either set up the frontend through a [local install](#local-machine) on your machine or using [Docker](#docker). Before checking out the repository you may need to [add an SSH key to your GitHub account](https://help.github.com/articles/generating-ssh-keys/). Before pushing changes you may need to [create an access token](https://help.github.com/articles/creating-an-access-token-for-command-line-use/). | |||
| You can either set up the frontend through a [local install](#local-machine) on your machine or using [Docker](#docker). Before checking out the repository you may need to add your guardian email address to your github account and [add an SSH key to your GitHub account](https://help.github.com/articles/generating-ssh-keys/). Before pushing changes you may need to [create an access token](https://help.github.com/articles/creating-an-access-token-for-command-line-use/). Also make sure, your github account was added to all concerned teams, in order to have full access. | |||
There was a problem hiding this comment.
Also make sure your github account was added to all concerned teams, in order to have full access
Passive voice can probably be replaced by something more specific like Make sure your dev manager has added you to team X and Y, so you can have access to all necessary repositories
What do you think?
There was a problem hiding this comment.
Generally I like the idea, but I wasn't sure, whether this is too guardian specific.
What do you think about a mix: Make sure your dev manager has added you to the necessary teams, in case you have need write access.?
I'm fine with your proposal, I just need to find out, what team X and Y could be :)
|
Seen on PROD (merged by @gustavpursche 21 minutes and 47 seconds ago) Please check your changes! |
What does this change?
Enhances quickstart documentation.
What is the value of this and can you measure success?
Better onboarding experience for upcoming people.