diff --git a/content/browsing.md b/content/browsing.md index 538dfbe9..df801287 100644 --- a/content/browsing.md +++ b/content/browsing.md @@ -46,9 +46,9 @@ First, we need to make our own copy of the exercise repository. This will become important later, when we make our own changes. 1. Go to the repository view on GitHub: - - : you can use this one if you don't want your fork and contributions + - : you can use this one if you don't want your fork and contributions to be visible on the stream or the recording - - : we will use this one for the demonstration which is streamed and recorded + - : we will use this one for the demonstration which is streamed and recorded 1. First, on GitHub, click the button that says "Fork". It is towards the top-right of the screen: :::{figure} img/browsing/forking.png @@ -62,7 +62,7 @@ become important later, when we make our own changes. At all times you should be aware of if you looking at *your* repository or the *CodeRefinery {term}`upstream`* repository. * Your repository: https://github.com/**USERNAME**/recipe-book -* CodeRefinery upstream repository: https://github.com/**coderefinery**/recipe-book +* CodeRefinery upstream repository: https://github.com/**cr-workshop-exercises**/recipe-book :::::{tabs} ::::{group-tab} GitHub @@ -372,8 +372,8 @@ $ git blame sides/guacamole.md ### (8) Browse issues and pull requests in the {term}`upstream` repository This can only be done through the GitHub view. Go to the main -repository **coderefinery/recipe-book**, (not your fork): -. {term}`Issues ` +repository **cr-workshop-exercises/recipe-book**, (not your fork): +. {term}`Issues ` and {term}`Pull requests ` are different for each GitHub copy. diff --git a/content/commits.md b/content/commits.md index 20f65d6f..d6deba0e 100644 --- a/content/commits.md +++ b/content/commits.md @@ -45,7 +45,7 @@ the other paths on day 2) :::{exercise} Exercise: Practice creating commits and branches (20 min) 1. Make sure that you now work **on your fork** of the recipe-book - repository (`USER/recipe-book`, *not* `coderefinery/recipe-book`) + repository (`USER/recipe-book`, *not* `cr-workshop-exercises/recipe-book`) 1. First create a new branch and then add a recipe to the branch and commit the change. 1. In a new commit, modify the recipe you just added. 1. Switch to the `main` branch and modify a recipe there. diff --git a/content/guide.md b/content/guide.md index 94d554fd..44f457e5 100644 --- a/content/guide.md +++ b/content/guide.md @@ -1,26 +1,38 @@ # Instructor guide +## Exercise preparation + :::{warning} -**Exercise preparation: one day before the workshop** +Do this at least one day before the workshop! +::: -- Create two exercise repository from - preserving history +- Create two exercise repositories from + **preserving history** (this means **not** using "generating from template") - - - - -- You can create these using `git clone --mirror` and `git push --mirror` to make sure to copy all branches. -- Create one or two issues to both -- Create one or two pull requests to both + - + - +- You can create these using `git clone --mirror` and `git push --mirror` to make sure to copy **all branches**: + ```console + $ git clone --mirror git@github.com:cr-workshop-exercises/recipe-book-template.git + $ cd recipe-book-template.git + $ git push --mirror git@github.com:cr-workshop-exercises/recipe-book-recorded.git + $ git push --mirror git@github.com:cr-workshop-exercises/recipe-book.git + ``` +- Reason why we create it under and not under + is that we otherwise get a 100 pull requests over the next few weeks + which masks "real" pull requests from the project and the side effect would be that nobody then reviews + any "real" pull requests anymore. +- Create one or two issues to both. +- Create one or two pull requests to both. - In both, try to search for something in the recipes to trigger a search index - update -::: + update. ## Privacy When presenting the material in a streamed and recorded workshop, make sure to -only show the +only show the repository. diff --git a/content/local-workflow.md b/content/local-workflow.md index b773bfbb..6ebf03fc 100644 --- a/content/local-workflow.md +++ b/content/local-workflow.md @@ -78,7 +78,7 @@ We have an own section for this: {ref}`configuration`. Now you need to decide which repository you want to clone. All of these options will work for this exercise since we don't plan to push changes back (for step 8 it might be easier to use the original repository): - Clone the recipe book from your fork. -- Or clone the recipe book from the original repository: +- Or clone the recipe book from the original repository: - Or first fork the original repository and then clone your fork. The examples below assume you are cloning the original repository. If you are cloning your fork, you should @@ -90,13 +90,13 @@ If you are unsure whether you are using SSH or HTTPS, please read {ref}`clone-me :::::{tabs} ::::{group-tab} SSH ```console - $ git clone git@github.com:coderefinery/recipe-book.git + $ git clone git@github.com:cr-workshop-exercises/recipe-book.git ``` :::: ::::{group-tab} HTTPS ```console - $ git clone https://github.com/coderefinery/recipe-book.git + $ git clone https://github.com/cr-workshop-exercises/recipe-book.git ``` :::: ::::: @@ -106,13 +106,13 @@ on your computer (in this case "my-recipe-book"): :::::{tabs} ::::{group-tab} SSH ```console - $ git clone git@github.com:coderefinery/recipe-book.git my-recipe-book + $ git clone git@github.com:cr-workshop-exercises/recipe-book.git my-recipe-book ``` :::: ::::{group-tab} HTTPS ```console - $ git clone https://github.com/coderefinery/recipe-book.git my-recipe-book + $ git clone https://github.com/cr-workshop-exercises/recipe-book.git my-recipe-book ``` :::: ::::: @@ -403,7 +403,7 @@ $ git branch ``` But where are the remote branches? We expect to see [a couple of -them](https://github.com/coderefinery/recipe-book/branches/all). +them](https://github.com/cr-workshop-exercises/recipe-book/branches/all). We can see them by asking for all branches (your output might vary depending on where you cloned from): diff --git a/content/merging.md b/content/merging.md index 7ee3ae88..bc3d518b 100644 --- a/content/merging.md +++ b/content/merging.md @@ -381,14 +381,14 @@ request. Not described. We will return to this in the [collaborative Git lesson](https://coderefinery.github.io/git-collaborative/). -You would create a new branch locally like above, {term}`push` it to GitHub to your own user's repository `USER/recipe-book`, then go to GitHub and open a pull request *to* `coderefinery/recipe-book`. Or you do it all through VS Code. +You would create a new branch locally like above, {term}`push` it to GitHub to your own user's repository `USER/recipe-book`, then go to GitHub and open a pull request *to* `cr-workshop-exercises/recipe-book`. Or you do it all through VS Code. :::: ::::{group-tab} Command line Not described. We will return to this in the [collaborative Git lesson](https://coderefinery.github.io/git-collaborative/). -You would create a new branch locally like above, {term}`push` it to GitHub to your own user's repository `USER/recipe-book`, then go to GitHub and open a pull request *to* `coderefinery/recipe-book`. +You would create a new branch locally like above, {term}`push` it to GitHub to your own user's repository `USER/recipe-book`, then go to GitHub and open a pull request *to* `cr-workshop-exercises/recipe-book`. :::: :::::