ITP: Update step submission instructions #1426

SpectacularLandscape · 2025-04-29T20:01:11Z

What does this change?

Updates ITP module success pages to ask learners to create an issue on their Coursework Planner with links, then submit the issue to the CYF Course Portal
- "objectives" front matter is updated to better fit the submission instructions
Adds a > [!NOTE] to each ITP module success page to explain a "completed" PR
Spring cleans ITP module success pages for consistency in "title" and "description" front matter

Checklist

I have read the contributing guidelines
I have checked my spelling and grammar with an automated tool
I have previewed my changes to check the markdown renders as I intend
I have run my code to check it works
My changes follow our Style Guide

Who needs to know about this?

@ZacheeNiyokwizera (task collaborator)
@CodeYourFuture/itp-syllabus-team (ITP content change review)
@SallyMcGrath (to continue discussion from #1425)
@kfklein15 (for updates to dashboard "acceptance criteria")

netlify · 2025-04-29T20:01:15Z

👷 Deploy request for cyf-curriculum pending review.

Visit the deploys page to approve it

Name	Link
🔨 Latest commit	`5dddb35`

netlify · 2025-04-29T20:01:15Z

👷 Deploy request for cyf-piscine pending review.

Visit the deploys page to approve it

Name	Link
🔨 Latest commit	`5dddb35`

netlify · 2025-04-29T20:01:15Z

👷 Deploy request for cyf-itd pending review.

Visit the deploys page to approve it

Name	Link
🔨 Latest commit	`5dddb35`

netlify · 2025-04-29T20:01:15Z

👷 Deploy request for cyf-common pending review.

Visit the deploys page to approve it

Name	Link
🔨 Latest commit	`5dddb35`

netlify · 2025-04-29T20:01:16Z

👷 Deploy request for cyf-tracks pending review.

Visit the deploys page to approve it

Name	Link
🔨 Latest commit	`5dddb35`

netlify · 2025-04-29T20:01:16Z

👷 Deploy request for cyf-sdc pending review.

Visit the deploys page to approve it

Name	Link
🔨 Latest commit	`5dddb35`

netlify · 2025-04-29T20:01:16Z

👷 Deploy request for cyf-launch pending review.

Visit the deploys page to approve it

Name	Link
🔨 Latest commit	`5dddb35`

SpectacularLandscape · 2025-04-29T20:01:38Z

org-cyf-itp/content/data-flows/success/index.md

 ## ✅ To complete _this_ module, you must:

-Submit the following items to complete this module on the [Course Platform](https://application-process.codeyourfuture.io/):
+1. Make a new issue on your own Coursework Planner.


Should we add specific guidance on how to name this issue, like we do for naming pull requests?

Given the point of the issue is to have a link to share, this doesn't feel super important, but nudging people towards consistency and following instructions is always a good idea? So probably yes?

SpectacularLandscape · 2025-04-29T20:05:42Z

org-cyf-itp/content/data-flows/success/index.md

+
+> [!NOTE]
+> A pull request is _completed_ when a volunteer has added the "Complete" tag. If no one is reviewing your PRs, please ask on Slack in #cyf-code-review.
+


This feels like a good place for a > [!CAUTION] to explain that failing to enroll as a trainee means the course can't be completed.

I just couldn't get the wording. It sounded like either:

You can't get a head start on work in the next module until fully enrolled

Enrolling as a trainee is the only true requirement to complete ITP

Example bad wording:

"You must enroll as a trainee to continue studying Intro To Programming."

"Enrolling as a trainee is required to complete Intro To Programming."

I think this should be a CAUTION on the Onboarding rather than Data Flows module?

But I think adding a warning there would make a lot of sense. Our policy is: If you haven't enrolled as a trainee by week 6, you will be removed from the ITP cohort.

So let's add a big caution to Onboarding's success page? Something like:

> [!CAUTION] > > You must enrol as a trainee. If you do not enrol as a trainee by the end of week 6, you will be removed from the ITP cohort. > > If you are removed from the cohort, you will be allowed to keep attending class. You can apply to start again in the next cohort if you want.

SpectacularLandscape · 2025-04-29T20:07:31Z

org-cyf-itp/content/data-groups/success/index.md

+    - A link to your _completed_ pull request for "[Sprint 2 Coursework](https://github.com/CodeYourFuture/Module-Data-Groups/issues/14)".
+    - A link to your _completed_ pull request for "[Quote Generator App](https://github.com/CodeYourFuture/Module-Data-Groups/issues/20)".
+    - A link to your "[Brag Diary](https://github.com/CodeYourFuture/Module-Data-Groups/issues/10)".
+    - An explanation of how you have used your "[Brag Diary](https://github.com/CodeYourFuture/Module-Data-Groups/issues/10)" to record your progress.


This is a carry over from the old front matter ("explain how you have used it to record your progress"), but remains vague.

There's also a note on the Brag Diary Issue that says it's fine not to share as it's a personal document, which could be confusing when we ask for it to be submitted.

SpectacularLandscape · 2025-04-29T20:10:07Z

org-cyf-itp/content/structuring-data/success/index.md

+1. On the issue, add:
+    - Evidence you have completed "[Intro to Python](https://github.com/CodeYourFuture/Module-Structuring-and-Testing-Data/issues/21)".
+    - A link to your _completed_ pull request for "[Sprint 3 Coursework Exercises](https://github.com/CodeYourFuture/Module-Structuring-and-Testing-Data/issues/6)".


I've seen most trainees submitting 3 pull request links on previous iterations of ITP.

Are we asking for just one PR (for sprint 3 exercises), or 3 PRs to cover all sprints? The linked issue suggests we want just one PR.

Let's ask for 3 PRs, one per sprint. We can link to all three issues, if that would be more clear, or just not link to the issue if that would be more clear too?

SpectacularLandscape · 2025-04-29T20:12:17Z

org-cyf-itp/content/onboarding/success/index.md

 +++

-> 🎯 Complete onboarding and [apply to enroll as a Trainee](https://forms.gle/vRuofa7aeL5DsbhGA)


Pointing this change out, as removing the note from the top of the page (where it gets noticed early) could be controversial.

To me it's a duplicate of steps below, and is vague on what it means to complete onboarding.

netlify · 2025-04-30T12:55:06Z

✅ Deploy Preview for cyf-programming ready!

Name	Link
🔨 Latest commit	`5dddb35`
🔍 Latest deploy log	https://app.netlify.com/sites/cyf-programming/deploys/6811300a9fb8810008773b3c
😎 Deploy Preview	https://deploy-preview-1426--cyf-programming.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.
Lighthouse	1 paths audited Performance: 100 (🟢 up 15 from production) Accessibility: 100 (no change from production) Best Practices: 92 (no change from production) SEO: 90 (no change from production) PWA: - View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify site configuration.

illicitonion

This looks great, thanks so much!

(Also for the future, PRs made from the CodeYourFuture repo get deploy previews by default, whereas ones from forks need manually allowing each time :))

illicitonion · 2025-04-30T12:54:21Z

org-cyf-itp/content/data-flows/success/index.md

 ## ✅ To complete _this_ module, you must:

-Submit the following items to complete this module on the [Course Platform](https://application-process.codeyourfuture.io/):
+1. Make a new issue on your own Coursework Planner.


Given the point of the issue is to have a link to share, this doesn't feel super important, but nudging people towards consistency and following instructions is always a good idea? So probably yes?

illicitonion · 2025-04-30T14:24:15Z

org-cyf-itp/content/data-flows/success/index.md

+
+> [!NOTE]
+> A pull request is _completed_ when a volunteer has added the "Complete" tag. If no one is reviewing your PRs, please ask on Slack in #cyf-code-review.
+


I think this should be a CAUTION on the Onboarding rather than Data Flows module?

But I think adding a warning there would make a lot of sense. Our policy is: If you haven't enrolled as a trainee by week 6, you will be removed from the ITP cohort.

So let's add a big caution to Onboarding's success page? Something like:

> [!CAUTION] > > You must enrol as a trainee. If you do not enrol as a trainee by the end of week 6, you will be removed from the ITP cohort. > > If you are removed from the cohort, you will be allowed to keep attending class. You can apply to start again in the next cohort if you want.

illicitonion · 2025-04-30T14:26:03Z

org-cyf-itp/content/structuring-data/success/index.md

+1. On the issue, add:
+    - Evidence you have completed "[Intro to Python](https://github.com/CodeYourFuture/Module-Structuring-and-Testing-Data/issues/21)".
+    - A link to your _completed_ pull request for "[Sprint 3 Coursework Exercises](https://github.com/CodeYourFuture/Module-Structuring-and-Testing-Data/issues/6)".


Let's ask for 3 PRs, one per sprint. We can link to all three issues, if that would be more clear, or just not link to the issue if that would be more clear too?

illicitonion · 2025-04-30T14:28:44Z

org-cyf-itp/content/data-groups/success/index.md

+    - A link to your _completed_ pull request for "[Alarm Clock App](https://github.com/CodeYourFuture/Module-Data-Groups/issues/26)".
+    - A link to your _completed_ pull request for "[Sprint 2 Coursework](https://github.com/CodeYourFuture/Module-Data-Groups/issues/14)".
+    - A link to your _completed_ pull request for "[Quote Generator App](https://github.com/CodeYourFuture/Module-Data-Groups/issues/20)".
+    - A link to your "[Brag Diary](https://github.com/CodeYourFuture/Module-Data-Groups/issues/10)".


Suggested change

- A link to your "[Brag Diary](https://github.com/CodeYourFuture/Module-Data-Groups/issues/10)".

- A link to your "[Brag Diary](https://github.com/CodeYourFuture/Module-Data-Groups/issues/10)". (It's ok if this is a private document, you don't need to share it if you don't want to, but please include the link for your own reference).

SpectacularLandscape · 2025-05-06T18:38:02Z

org-cyf-itp/content/data-groups/success/index.md

+> [!NOTE]
+> A pull request is _completed_ when a volunteer has added the "Complete" tag. If no one is reviewing your PRs, please ask on Slack in #cyf-code-review.


Throughout all modules, this note can mention one week as a guideline for how long a PR can go 'unreviewed' by a volunteer

SpectacularLandscape added 4 commits April 29, 2025 19:29

Update module sucess page titles for consistency

ca70b92

Update module sucess page descriptions for consistency

7787ce7

Update front matter and page markdown

04d25b9

Remove duplicative comment

5dddb35

github-project-automation bot added this to Curriculum Planning Apr 29, 2025

github-project-automation bot moved this to 📋 Backlog in Curriculum Planning Apr 29, 2025

SpectacularLandscape commented Apr 29, 2025

View reviewed changes

SpectacularLandscape mentioned this pull request Apr 29, 2025

ITP: Update step submission instructions and "Success" page theme #1425

Closed

6 tasks

illicitonion reviewed May 1, 2025

View reviewed changes

SpectacularLandscape commented May 6, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

ITP: Update step submission instructions #1426

ITP: Update step submission instructions #1426

SpectacularLandscape commented Apr 29, 2025

netlify bot commented Apr 29, 2025

netlify bot commented Apr 29, 2025

netlify bot commented Apr 29, 2025

netlify bot commented Apr 29, 2025

netlify bot commented Apr 29, 2025

netlify bot commented Apr 29, 2025

netlify bot commented Apr 29, 2025

SpectacularLandscape Apr 29, 2025

illicitonion Apr 30, 2025

SpectacularLandscape Apr 29, 2025 •

edited

Loading

illicitonion Apr 30, 2025

SpectacularLandscape Apr 29, 2025

SpectacularLandscape Apr 29, 2025

illicitonion Apr 30, 2025

SpectacularLandscape Apr 29, 2025

netlify bot commented Apr 30, 2025 •

edited

Loading

illicitonion left a comment

illicitonion Apr 30, 2025

illicitonion Apr 30, 2025

illicitonion Apr 30, 2025

illicitonion Apr 30, 2025

SpectacularLandscape May 6, 2025


		> [!NOTE]
		> A pull request is _completed_ when a volunteer has added the "Complete" tag. If no one is reviewing your PRs, please ask on Slack in #cyf-code-review.

		+++

		> 🎯 Complete onboarding and [apply to enroll as a Trainee](https://forms.gle/vRuofa7aeL5DsbhGA)

	- A link to your "[Brag Diary](https://github.com/CodeYourFuture/Module-Data-Groups/issues/10)".
	- A link to your "[Brag Diary](https://github.com/CodeYourFuture/Module-Data-Groups/issues/10)". (It's ok if this is a private document, you don't need to share it if you don't want to, but please include the link for your own reference).

ITP: Update step submission instructions #1426

Are you sure you want to change the base?

ITP: Update step submission instructions #1426

Conversation

SpectacularLandscape commented Apr 29, 2025

What does this change?

Checklist

Who needs to know about this?

netlify bot commented Apr 29, 2025

👷 Deploy request for cyf-curriculum pending review.

netlify bot commented Apr 29, 2025

👷 Deploy request for cyf-piscine pending review.

netlify bot commented Apr 29, 2025

👷 Deploy request for cyf-itd pending review.

netlify bot commented Apr 29, 2025

👷 Deploy request for cyf-common pending review.

netlify bot commented Apr 29, 2025

👷 Deploy request for cyf-tracks pending review.

netlify bot commented Apr 29, 2025

👷 Deploy request for cyf-sdc pending review.

netlify bot commented Apr 29, 2025

👷 Deploy request for cyf-launch pending review.

Choose a reason for hiding this comment

Choose a reason for hiding this comment

SpectacularLandscape Apr 29, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

netlify bot commented Apr 30, 2025 • edited Loading

✅ Deploy Preview for cyf-programming ready!

illicitonion left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

SpectacularLandscape Apr 29, 2025 •

edited

Loading

netlify bot commented Apr 30, 2025 •

edited

Loading