Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make the video about coursework-planner more noticeable #786

Open
pseudopilot opened this issue Jul 8, 2024 · 2 comments
Open

Make the video about coursework-planner more noticeable #786

pseudopilot opened this issue Jul 8, 2024 · 2 comments
Labels
discussion ITP Work belongs to or is needed for ITP
Milestone

Comments

@pseudopilot
Copy link
Contributor

pseudopilot commented Jul 8, 2024

What is the hypothesis?

In Set Up Planner Section there are step-by-step instructions followed by the line:

You can watch this video about how to create your coursework-planner board.

This video seems to be more detailed than the text instruction and answers some questions I had when going step-by-step following the text instruction.
But unfortunately I noticed this video link already after finishing setting up coursework-planner following text instructions.

Does it maybe make more sense to move the video link before the text instructions or, as an option, turn it into imbedded video so that it would be noticeable from the very beginning as a source of additional information to the text instructions.

Why is this important?

It may give provide some additional clarification to what to do and how to do it.
For example, which settings to choose for Kamino Clone button:

image

or which options to choose while cloning the issue:

image

Additionally do we maybe want to ask trainees to check these settings options by default to prevent comments/mentions on original issues:

[x] Disable Kamino automatic comments on original issue
[x] Prevent references to cloned issue on original issue (using this hacky method)

@pseudopilot pseudopilot added discussion ITP Work belongs to or is needed for ITP labels Jul 8, 2024
@JayMayer
Copy link
Member

JayMayer commented Jul 9, 2024

I think this section will need a rewrite. Kamino is still used by some trainees, but the tool mentioned on the Set Up Planner page:

We are building a tool to automate this process

... is now built. Source code here:

https://github.com/CodeYourFuture/curriculum/blob/e07b73a754b7f950eec07de3aed70e4925424f39/org-cyf/tooling/netlify/functions/clone.ts

The tool appears as the "Clone" button next to each issue on the curriculum site backlog pages.

My vote is to push use of the "Clone" button. Whilst Kamino does make the underlying action transparent ('I'm cloning an issue from this repository into my own repo/planner'), it's a pain to configure the keys with a group of trainees, and suffers from problems with default settings as above.

@moneyinthesky
Copy link
Contributor

I second that vote @JayMayer 🤚
Good news that the clone button is now built 🎉

@SallyMcGrath SallyMcGrath added this to the ITP milestone Jul 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
discussion ITP Work belongs to or is needed for ITP
Projects
Status: 📋 Backlog
Development

No branches or pull requests

4 participants