Skip to content

Commit

Permalink
exercise repo needs to be outside CR org; closes #466
Browse files Browse the repository at this point in the history
otherwise we will get 100 pull requests, also in-between workshops,
which may mask other pull requests
  • Loading branch information
bast committed Sep 1, 2024
1 parent 3b3b660 commit c0e68a0
Show file tree
Hide file tree
Showing 5 changed files with 37 additions and 25 deletions.
10 changes: 5 additions & 5 deletions content/browsing.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
- <https://github.com/coderefinery/recipe-book>: you can use this one if you don't want your fork and contributions
- <https://github.com/cr-workshop-exercises/recipe-book>: you can use this one if you don't want your fork and contributions
to be visible on the stream or the recording
- <https://github.com/coderefinery/recipe-book-recorded>: we will use this one for the demonstration which is streamed and recorded
- <https://github.com/cr-workshop-exercises/recipe-book-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
Expand All @@ -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
Expand Down Expand Up @@ -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):
<https://github.com/coderefinery/recipe-book>. {term}`Issues <issue>`
repository **cr-workshop-exercises/recipe-book**, (not your fork):
<https://github.com/cr-workshop-exercises/recipe-book>. {term}`Issues <issue>`
and {term}`Pull requests <pull request>` are different for each GitHub
copy.

Expand Down
2 changes: 1 addition & 1 deletion content/commits.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
34 changes: 23 additions & 11 deletions content/guide.md
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.


Expand Down
12 changes: 6 additions & 6 deletions content/local-workflow.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
```
::::
:::::
Expand All @@ -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
```
::::
:::::
Expand Down Expand Up @@ -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):
Expand Down
4 changes: 2 additions & 2 deletions content/merging.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`.

::::
:::::
Expand Down

0 comments on commit c0e68a0

Please sign in to comment.