docs: add Git branching best practices and optimize Netlify deployment instructions#29
docs: add Git branching best practices and optimize Netlify deployment instructions#29Grajales-K wants to merge 6 commits into
Conversation
Updated the success criteria to clarify that students should only deploy to Netlify once they reach Level 500. This change helps students avoid exhausting their Netlify build credits during the earlier stages of the project
Added best practices for Git branching and deployment. Encouraging students to use feature branches for Level 500 and deploy only after final merge to optimize Netlify usage.
illicitonion
left a comment
illicitonion
left a comment
There was a problem hiding this comment.
Generally LGTM - let's avoid repeating the contents of the deployment guides here, so that if the steps need to change (e.g. if Netlify change their screens) we only need to update one place not multiple.
|
Hi @illicitonion, thank you so much for carefully checking my changes. I have updated the file and removed the repetitive information that is already covered in the official documentation. I hope this is clearer now! |
illicitonion
left a comment
illicitonion
left a comment
There was a problem hiding this comment.
Thank you!
We'll merge this next week - we have a few trainees who are racing through ITP in the first couple of weeks, and we don't want to change the expectations/rules for them while they're doing so, but will make sure this gets deployed before the main ITP cohort reaches this stage!
|
Thank you so much, @illicitonion. The pictures are slightly blurry. If you'd like, I can take new ones. Just let me know! Thanks for accepting my changes ❤️. It was very difficult to find the success criteria in the data flows, and this one.🥴 |
|
If you can improve the pictures, that would be great, but fine if not! Thank you! |
2 participants
Revised PR Description
Problem: Currently, the instructions do not introduce GitHub Pages for early deployment, leading to unnecessary consumption of Netlify build credits. Additionally, the Level 500 instructions lack explicit guidance on feature branches and final deployment setup.
Changes:
Level 0: Replaced Netlify with GitHub Pages for initial deployment to provide a free, unlimited hosting option during early development.
Level 500: * Moved Netlify deployment instructions here as the final "production" step.
Added link references for both level 0 and 500 to the official deployment documentation for GitHub Pages and Netlify.
Added a "Technical Workflow" section to encourage the use of feature branches (feature/level-500) after merging Level 400.
Aligned instructions with dashboard submission requirements to reduce student confusion.