Update cloning instructions (#8)

* Update cloning instructions We now have a clone button. Preserve the manual instructions and workarounds in a collapsed details tab in case there are issues with the clone button. * Making Coursework Planner set up a bit mmore clear * More tweaks --------- Co-authored-by: Barath Vignarajah <[email protected]>
RihannaP · Sep 29, 2024 · 93f6452 · 93f6452
1 parent e94024f
commit 93f6452
Show file tree

Hide file tree

Showing 9 changed files with 41 additions and 14 deletions.
diff --git a/images/create-planner-fork.png b/images/create-planner-fork.png
diff --git a/images/fork-planner.png b/images/fork-planner.png
diff --git a/images/fork-settings-issues.png b/images/fork-settings-issues.png
diff --git a/images/link-project-board.png b/images/link-project-board.png
diff --git a/images/project-board-copy-form.png b/images/project-board-copy-form.png
diff --git a/images/project-board-copy.png b/images/project-board-copy.png
diff --git a/images/project-board-public.png b/images/project-board-public.png
diff --git a/images/project-board-settings.png b/images/project-board-settings.png
diff --git a/readme.md b/readme.md
@@ -1,32 +1,59 @@
 # Welcome to your coursework planner
 
-This is how you will plan and manage your coursework at CYF. You will add all your work as issues to your fork of this repository, and then use a [project board](https://github.com/CodeYourFuture/Coursework-Planner/projects?query=is%3Aopen) to manage your work. This is broadly how all technical projects are managed, so you will need lots of practice. Get started today.
+This is how you will plan and manage your coursework at CYF. You will add all your work as issues to your fork of this repository, and then use a [project board](https://github.com/CodeYourFuture/My-Coursework-Planner/projects?query=is%3Aopen) to manage your work. This is broadly how all technical projects are managed, so you will need lots of practice. Get started today.
 
 ## 1. How to get set up
 
-1. Fork [this repo](https://github.com/CodeYourFuture/Coursework-Planner/) to your own GitHub
-2. Turn on `issues` in the `settings`
+#### Forking the My-Coursework-Planner repo
 
-You must fork to your personal Github account. Forks created in the CYF org will be deleted by a bot.
+1. Fork [this repo](https://github.com/CodeYourFuture/My-Coursework-Planner/) to your own GitHub
+![image](images/fork-planner.png)
+2. You should see your own GitHub username under `Owner`
+![image](images/create-planner-fork.png)
+3. Turn on `issues` in the `Settings` of your forked version of the repo
+![image](images/fork-settings-issues.png)
 
-## 2. Every module, you will add your work as issues
+***You must fork to your personal Github account. Forks created in the CYF org will be deleted by a bot.***
+
+#### Creating your project board
+
+1. Go to the [example project board](https://github.com/CodeYourFuture/Coursework-Planner/projects?query=is%3Aopen)
+2. Click the three-dot menu, and then select `Make a copy`
+![image](images/project-board-copy.png)
+3. Make sure your own GitHub username is under `Owner`
+![image](images/project-board-copy-form.png)
+4. Make your project board public so your mentors can see your progress - open the project board settings
+![image](images/project-board-settings.png)
+5. Scroll to the bottom to find the setting to make your board public
+![image](images/project-board-public.png)
+
+#### Linking the My-Coursework-Planner repo to your project board
+1. Go back to your forked version of the My-Coursework-Planner repo
+2. Under `Projects`, click `Link a project` and select your project board
+![image](images/link-project-board.png)
+3. That's it! You're ready to start adding issues to your board!
+
+## 2. In every module, you will add your work as issues
+
+Each sprint in each module has a Backlog page which lists the work you're expected to do for that module. Every item in the list is actually a GitHub issue.
+
+There is a "Clone" button next to each issue. When you're starting a sprint, clone each of its issues into your coursework planner.
+
+Copy issues for each week or at most for each module. The coursework content is updated frequently, you will not have the most up to date tasks on your board if you copy all modules at once.
+
+<details>
+<summary>If the Clone button isn't working, expand this for instructions of how to manually clone the issues</summary>
 
 Each module has a module repo. The coursework for each module is added as issues to that repository. All the module repos are listed in the [Table of Contents](https://github.com/CodeYourFuture/Table-of-Contents).
 
 1. Go to the module repo
 2. Click on the `Issues` tab
 3. Copy each issue from the module repo to your own coursework repo.
 
-We are building a tool to automate this process, but for now you will have to do it manually. We all use the [Kamino Clone Button](https://chrome.google.com/webstore/detail/kamino/ffdebockfdjileaojbbccofhgncmioaf?hl=en) Chrome extension to make this easier, so you could try that.
-
-Copy issues for each week or at most for each module. The coursework content is updated frequently, you will not have the most up to date tasks on your board if you copy all modules at once.
-
-## 3. Refine your tickets and add them to your project board
+We have also used the [Kamino Clone Button](https://chrome.google.com/webstore/detail/kamino/ffdebockfdjileaojbbccofhgncmioaf?hl=en) Chrome extension to make this easier, so you could try that.
+</details>
 
-1. Copy the [example project board](https://github.com/CodeYourFuture/Coursework-Planner/projects?query=is%3Aopen)
-2. Link your new project board to your fork of this repo
-3. Add your tickets to the project board, using the labels to help you assign the fields
-4. Make your board public in the settings, so your mentors can see it
+## 3. Manage and adapt your project board as you learn
 
 There are example project boards attached to each module, showing you ways you can use boards to manage your time, prioritise, scope, and track your work. You should use the _same project board_ all the way through the course, and add to it as you go. Learn as you go, and adapt your board as you learn.