-
Notifications
You must be signed in to change notification settings - Fork 70
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
exercise repo needs to be outside CR org; closes #466
otherwise we will get 100 pull requests, also in-between workshops, which may mask other pull requests
- Loading branch information
Showing
5 changed files
with
37 additions
and
25 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 | ||
<https://github.com/coderefinery/recipe-book-template> preserving history | ||
- Create two exercise repositories from | ||
<https://github.com/cr-workshop-exercises/recipe-book-template> **preserving history** | ||
(this means **not** using "generating from template") | ||
- <https://github.com/coderefinery/recipe-book> | ||
- <https://github.com/coderefinery/recipe-book-recorded> | ||
- 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 | ||
- <https://github.com/cr-workshop-exercises/recipe-book> | ||
- <https://github.com/cr-workshop-exercises/recipe-book-recorded> | ||
- You can create these using `git clone --mirror` and `git push --mirror` to make sure to copy **all branches**: | ||
```console | ||
$ git clone --mirror [email protected]:cr-workshop-exercises/recipe-book-template.git | ||
$ cd recipe-book-template.git | ||
$ git push --mirror [email protected]:cr-workshop-exercises/recipe-book-recorded.git | ||
$ git push --mirror [email protected]:cr-workshop-exercises/recipe-book.git | ||
``` | ||
- Reason why we create it under <https://github.com/cr-workshop-exercises> and not under | ||
<https://github.com/coderefinery> 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 <https://github.com/coderefinery/recipe-book-recorded> | ||
only show the <https://github.com/cr-workshop-exercises/recipe-book-recorded> | ||
repository. | ||
|
||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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: <https://github.com/coderefinery/recipe-book> | ||
- Or clone the recipe book from the original repository: <https://github.com/cr-workshop-exercises/recipe-book> | ||
- 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 [email protected]:coderefinery/recipe-book.git | ||
$ git clone [email protected]: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 [email protected]:coderefinery/recipe-book.git my-recipe-book | ||
$ git clone [email protected]: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): | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters