ci_mentor_insights

This is an attempt to provide more standardized readme examples for students for each milestone project.

The hope is to provide a more standard writeup to lead students to success and make assessments easier to conduct and less reliant on an assessor's ability to dig into code and hunt and peck for specific assessment criteria.

Project Specific Readme Templates

Ecommerce Path with 5 Portfolio Projects

• Portfolio 1: HTML/CSS Essentials
• Portfolio 2: Javascript Essentials
• Portfolio 3: Python Essentials
• Portfolio 4: Full Stack Toolkit
• Portfolio 5: E-commerce Applications

Ecommerce Path with 4 Milestone Projects

• MS1: User Centric Frontend Readme Template
• MS2: Interactive Frontend Template
• MS3: Backend Development with Flask Template
• MS4: Fullstack Django Template

Helpful Templates

I've also added links to helpful google templates that I created for myself when going through the course. I reference the following in at least one of the readme templates:

• Manual Testing Template
• Defect Tracking Template

Helpful tools

Markdown's not all that easy so sometimes you may want to use some tools to make tables.

• Markdown Cheatsheet
• markdown table generator - used to help with documentation table formatting
• mardown table of contents generator - used to create table of contents (be weary it does have some bugs if you have dashes or trailing spaces in your headers)

The hope is to provide a more standard writeup to lead students to success and make assessments easier to conduct and less reliant on an assessor's ability to dig into code and hunt and peck for specific assessment criteria.

README Screen shots

1. Scroll down and Click the README.md edit buton (it looks like a pencil)

2. Capture your screenshot

• For Windows: Use Shift+Windows Key+S to bring up Snip & Sketch, after you have the screenshot taken
• For Mac: Control+ Command + Shift + 4

3. The image should now be in your computer's memory so all you do is go to the place in your readme where you want that image
4. Use the paste command, and github will auto upload the image and make the right markdown for you! Magic!

• Windows Control + V
• Mac Command + V

4. Make sure add a line return before and after so it doesn't mash up to your text in a weird way. Seriously this is what I did. with this documentation.

5. Commit the change in your github browser:

6. Note This will get you behind in your gitpod if you have that open, so watch out for that and do a pull.