Skip to content

Commit

Permalink
Standardized all Markdowns using prettier (#1285)
Browse files Browse the repository at this point in the history
  • Loading branch information
ravireddy07 authored Apr 9, 2020
1 parent c49005a commit 752e3af
Show file tree
Hide file tree
Showing 228 changed files with 8,695 additions and 4,611 deletions.
25 changes: 25 additions & 0 deletions .prettierrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
{
"arrowParens": "always",
"bracketSpacing": true,
"jsxBracketSameLine": false,
"jsxSingleQuote": false,
"semi": true,
"singleQuote": true,
"tabWidth": 2,
"useTabs": false,
"quoteProps": "as-needed",
"trailingComma": "none",
"requirePragma": false,
"insertPragma": false,
"proseWrap": "preserve",
"vueIndentScriptAndStyle": false,
"endOfLine": "auto",
"overrides": [
{
"files": "*.md",
"options": {
"singleQuote": true
}
}
]
}
5 changes: 4 additions & 1 deletion CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,13 @@
# Techtonica Mission and Code of Conduct

Last modified: 11 September 2016

## Mission
## Mission

Techtonica’s mission is to make every engineering team as diverse as its local community while empowering low-income women and non-binary adults through tech training and careers.

### Short Form Code of Conduct

Techtonica is dedicated to providing a safe, inclusive, welcoming, and harassment-free space and experience for all members and guests, regardless of gender identity and expression, sexual orientation, disability, physical appearance, socioeconomic status, body size, ethnicity, nationality, level of experience, age, or religion (or lack thereof). Our Code of Conduct exists because of that dedication. We do not tolerate harassment in any form and we prioritize marginalized people’s safety over privileged people’s comfort.

For more details, see our full [Code of Conduct](https://docs.google.com/document/d/16LUxODmHN3N2r4GPA-YeNgXP0MIQCl6gW_twJralb5w/edit)
1 change: 0 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,6 @@
- Review our [Style Guide](_templates/) to make sure your changes conform to it
- If you are new to how to contribute to GitHub projects, review the GSSoC guide or talk to a mentor (M) in Slack


## Step 1: Other Volunteers

1. Find any unassigned open issue in [our backlog](https://github.com/Techtonica/curriculum/projects/2)
Expand Down
42 changes: 21 additions & 21 deletions LICENSE.MD

Large diffs are not rendered by default.

17 changes: 13 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,32 +13,38 @@ An apprenticeship aims to be more like the workplace to make the transition into
If you would like to contribute to the curriculum, please [sign up here](https://docs.google.com/forms/d/e/1FAIpQLSeW0mo-Dpsig70374UEPvzexpas-31Ost_HsFwm0kjNOxtbtg/viewform?c=0&w=1), then choose an issue in the [to-do list.](https://github.com/Techtonica/curriculum/projects/2)

**Get started:**

- Choose an issue from the [TO-DO](https://github.com/Techtonica/curriculum/projects/2) column that seems right for you & leave a comment for Techtonica staff. If you know someone connected to Techtonica, they may be able to add you to our slack channel. If you are here for GHC or Hacktoberfest, message Alina, Leah, or TaLea and say you'd like to pick up the issue.
- In the issue, you should find a link for a lesson outline and for corresponding slides.
- If it is in the ["TO-DO"](https://github.com/Techtonica/curriculum/projects/2) column, that means it is available, even if there's an "assignee".
- To **create an outline**, fork the repo or commit directly onto the master branch. [Here is a topic outline template that explains what we need for each section](./_templates/topic-outline.md).
- To **create an outline**, fork the repo or commit directly onto the master branch. [Here is a topic outline template that explains what we need for each section](./_templates/topic-outline.md).
- To **edit a slideshow**, you'll need to request edit permission by clicking View Only > Request Edit Access, or message Alina. If you are logged into an account ending in @gmail.com, you can simply make a copy, edit, and transfer ownership to [email protected] when you finish. Either way, save on top of the sample template used in the slide, and cut any slides you find unnecessary.
- To make a **video**, one effective solution has been to record your screen as you explain the lesson slides to the apprentices. An alternative can be a video found online that covers all the objectives of the lesson in a way suited to beginners.
- Here is an **example** of a great lesson trio: [MongoDB Slides](https://docs.google.com/presentation/d/1BvO6PrSpulHVSDNOkMaDZM-V7McmheLgm0Lg2PFae7k/edit#slide=id.p), [MongoDB Lesson Outline](./databases/mongo-db.md), [MongoDB Video](https://drive.google.com/file/d/1022MSkPjfRyGAUQa2I-pQltpUn4Q1NJc/view).
- To make a **video**, one effective solution has been to record your screen as you explain the lesson slides to the apprentices. An alternative can be a video found online that covers all the objectives of the lesson in a way suited to beginners.
- Here is an **example** of a great lesson trio: [MongoDB Slides](https://docs.google.com/presentation/d/1BvO6PrSpulHVSDNOkMaDZM-V7McmheLgm0Lg2PFae7k/edit#slide=id.p), [MongoDB Lesson Outline](./databases/mongo-db.md), [MongoDB Video](https://drive.google.com/file/d/1022MSkPjfRyGAUQa2I-pQltpUn4Q1NJc/view).

**While working:**

- Comment in the issue if you have a question, or send a slack message.
- People are welcome to team up on an issue. If you see someone is already assigned but you want to help, leave the other assignee a message on the issue about collaborating.
- People are welcome to team up on an issue. If you see someone is already assigned but you want to help, leave the other assignee a message on the issue about collaborating.
- Please note the **due date**! Any amount of help is appreciated, but if the deadline approaches and you won't be able to complete it, please leave a comment about your progress and unassign yourself from the issue so someone else can pick it up. If you forked the repo, go ahead and make a pull request with what you have, and transfer ownership of a copied slideshow to [email protected].

**Completed curriculum:**

- Place a "completed" label on the issue once you've completed it, make a pull request to Techtonica/curriculum master, and leave comments about your work if you like. Grazie Mille!!

We'd love your help in improving this curriculum. See [CONTRIBUTING](./CONTRIBUTING.md) for details.

## Table of Contents

The following is the approximate sequence of the topics during the program but is always being tuned and optimized so if you have questions, please open an issue.

### Week 0 - Pre-Work

Before beginning the program, apprentices meet weekly for 4 weeks to learn JavaScript fundamentals.
Apprentices should memorize [**this**](Cheatsheet.md) within the first month.

### Week 1 - Onboarding & Developer Tools

1. [Welcome, Tips, and Rules](/onboarding/tech-industry-tips.md)
1. [Expectations While at Techtonica](https://docs.google.com/document/d/1IWny-IXB-XDWW21l3JODwPuh1QOVBFQbii_DjvF0g00/edit?usp=sharing)
1. [How to Learn](/onboarding/learning-to-learn.md)
Expand Down Expand Up @@ -142,6 +148,7 @@ Apprentices should memorize [**this**](Cheatsheet.md) within the first month.
1. [Database Migrations](/databases/database-migrations.md)

### Week 8 - Eventonica with React

1. [Eventonica Project](/projects/eventonica/eventonica-project.md)
1. [React Part 1](/react-js/react.md)
1. [React Part 2](/projects/eventonica/eventonica-react.md)
Expand Down Expand Up @@ -219,6 +226,7 @@ Apprentices should memorize [**this**](Cheatsheet.md) within the first month.
### Independent Topics

These are not blockers for any of the core sequence and so they are worked into the schedule as time permits.

1. [Interpersonal Conflict Resolution](/career/conflict-resolution.md)
1. [Diversity, Inclusion & Implicit Bias](/diversity-inclusion-bias/inclusion.md)
1. [Tech Tips and Rules](https://docs.google.com/document/d/1SWiUl0lYQ0sYDM8vQnVhJVOvT4MRA-9pDglKOgqTWak/edit)
Expand All @@ -243,6 +251,7 @@ These are not blockers for any of the core sequence and so they are worked into
- [Mobile Development](/mobile-development/mobile-development.md)

### Creative Commons Open-Source License

This work is licensed under a [Creative Commons Attribution-ShareAlike 4.0 International License](https://creativecommons.org/licenses/by-sa/4.0/legalcode).

[![CC BY-SA 4.0](https://i.creativecommons.org/l/by-sa/4.0/88x31.png)](https://creativecommons.org/licenses/by-sa/4.0/legalcode)
5 changes: 3 additions & 2 deletions _templates/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,12 @@ First thanks for volunteering to help Techtonica improve its curriculum!
We haven't built our full [style guide (NOT YET BUILT)](https://github.com/Techtonica/curriculum/issues/596) or automated all styling checks. In the meantime, read the tips below and check existing docs for examples. When in doubt, ask the project maintainers.

### Links - Always Relative!

- Links to other parts of the curriculum should be relative links, not https://github.com links
- Do not repeat the link contents in the link text - come up with a clear title (don't use "Click here")

### Lesson Outline Style TL;DR

- Be concise
- Favor concrete examples over theory
- Favor inline code examples over links
Expand All @@ -36,7 +38,7 @@ Try to get someone to run through the lesson and exercises. Ideally, most lesson

## Links vs. Original Content

Typically, tutorials already exist for most of our lessons. Your job as a contributor is to provide the *context and glue* that turns a list of external links into a cohesive lesson.
Typically, tutorials already exist for most of our lessons. Your job as a contributor is to provide the _context and glue_ that turns a list of external links into a cohesive lesson.

## Outline vs. Slides vs. Slide Video

Expand All @@ -47,4 +49,3 @@ To support different learning styles, we like to offer the content in these thre
## Okay I am ready to get started

Use the [template docs in this folder](/_templates/).

8 changes: 4 additions & 4 deletions _templates/elective.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,23 +16,23 @@ Write one short paragraph or bulleted list than answers the following:

- Why is it worth spending extra time to learn this technology?
- How do it compare do similar material covered in the main curriculum. See the root [README](/README.md) for topics already covered
- What problem does it solve?
- What problem does it solve?
- Why would you recommend it?
- Do not go into implementation details, as you can link to docs that do that later

## Description

What is the technology? Instead of using the project's own description, how would you describe it to a junior engineer?
What is the technology? Instead of using the project's own description, how would you describe it to a junior engineer?

## How to Get Started

Link to a free hands-on tutorial on getting started with the app. [Example for React](https://reactjs.org/tutorial/tutorial.html) from their official docs.

Please only include one tutorial here, one you gave gone through yourself and vetted for quality. If you have a few you like, choose the best one for a beginner audience. Any runner-ups can go in the "Further Reading" section below.


## Further Reading
- For a library/tool always include links to the official docs and

- For a library/tool always include links to the official docs and
- link its GitHub page
- The next best thing to read after the above content
- A list of important links to blogs and docs about the tech
7 changes: 3 additions & 4 deletions _templates/project.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,12 @@ Here is an example of a well-defined project, [Eventonica Part 3 (jQuery)](../pr

## Primary Goal

- To build ______
- To build **\_\_**
- Include why that's useful in the world of software projects

### Secondary Goals

- Practice skills in ______
- Practice skills in **\_\_**

## Helpful Resources

Expand All @@ -25,8 +25,8 @@ Here is an example of a well-defined project, [Eventonica Part 3 (jQuery)](../pr

## Instructions


### Step 1 - Create X

- For earlier projects, you should include very step-by-step instructions with code snippets.
- For later projects, you can just include any important intro steps and some code examples of the first step(s).

Expand All @@ -42,4 +42,3 @@ _Template users note: these requirements should usually be identical_
Please submit using the normal pull request submission process. If you are not 100% done by the deadline, submit what you have and note in the PR description what remains to be done.

# Good luck!

34 changes: 22 additions & 12 deletions _templates/projects.md
Original file line number Diff line number Diff line change
@@ -1,48 +1,56 @@
## Project Title
## Project Title

### Languages

- Lang1
- Lang2

### Frameworks

- FW1
- FW2

### Primary Goals

1. Include the Objectives to be practiced in this section.
Each project's primary learning outcomes should directly reflect the objectives for each topic that is covered with the project.
Each project's primary learning outcomes should directly reflect the objectives for each topic that is covered with the project.

### Overview
In this project, you will build _________ to practice _______.

In this project, you will build \***\*\_\*\*** to practice **\_\_\_**.

### Context

- This is what you already know, and we are building on top of it
- This is why you are building this app.
- This is the value to your future self if you do this lab exercise

### Basic Requirements

1. Participants will submit the project as a pull request by assigned date.

## Setup Instructions

Use the Terminal to navigate around the file system and creating new folders and files. Refer to the lesson on [Shell Commands](https://docs.google.com/presentation/d/1LuOLcpSAtNQlbULx9nWgXJNhgWQlfQ4nzLWQ0DuuPQk/edit?usp=sharing) if you need guidance on using the Terminal.

When you get to the steps below that ask you to initialize a git repo and track files using git, refer to the lesson on [Git and Version Control](https://docs.google.com/presentation/d/1znMOomkIkAkFKIz2e6t5tLpyzObKqOwfd90fsixSiec/edit?usp=sharing) if you need guidance.

Navigate to the `techtonica-labs` folder located in your Desktop.
Create a new folder called `getting-started-with-node` within the `techtonica-labs` folder.
Navigate to `getting-started-with-node`.
Initialize `getting-started-with-node` as a git repository.
Navigate to the `techtonica-labs` folder located in your Desktop.
Create a new folder called `getting-started-with-node` within the `techtonica-labs` folder.
Navigate to `getting-started-with-node`.
Initialize `getting-started-with-node` as a git repository.

If you have questions, do not disturb other pairs until you have spent 15-20 minutes troubleshooting within your own pair. Post a message on the #help channel in Slack if you and your pair partner are still stuck after 15-20 minutes. Be sure to format your question using the template we practiced in the [Asking Good Questions](https://docs.google.com/presentation/d/1O45nkq2bZX4ZDenmmA1lJ3iTvI80RXiPuOX2w__6Ykw/edit?usp=sharing) lesson.

## Project Instructions

### Starter Code
[Here is a link to the starter code for this lab exercise](http://www.google.com) OR There is no starter code for this project

[Here is a link to the starter code for this lab exercise](http://www.google.com) OR There is no starter code for this project

### Project

-----
---

#### Part 1 - Thing they will do (should match Basic Requirement 1 from above)

Expand All @@ -61,7 +69,7 @@ Etiam eleifend est ac auctor pretium. Pellentesque eu quam urna. Morbi mattis pu

[Add screenshots or images whenever possible](https://stackoverflow.com/questions/10189356/how-to-add-screenshot-to-readmes-in-github-repository) to clarify what you mean, and so participants can verify they've done the task correctly.

-----
---

#### Part 2 - Thing they will do (should match Basic Requirement 2 from above)

Expand All @@ -80,14 +88,16 @@ Etiam eleifend est ac auctor pretium. Pellentesque eu quam urna. Morbi mattis pu

[Add screenshots or images whenever possible](https://stackoverflow.com/questions/10189356/how-to-add-screenshot-to-readmes-in-github-repository) to clarify what you mean, and so participants can verify they've done the task correctly.

-----
---

### Questions to Consider

- Ask questions here that connect what is being done in the project to what was covered in the given weeks Topic Outlines.
- Ask questions that connect this project to prior Topic Outlines or Independent Practice.
- Also ask questions that require the participants to put together multiple pieces of knowledge to arrive at an answer or opinion.

### Extensions
- What deliverables can you as an participants work on once you have fulfilled the basic requirements for this project?

- What deliverables can you as an participants work on once you have fulfilled the basic requirements for this project?
- What do these deliverables add to their understanding of the topic?
- Extensions are designed for participants who are moving through the material faster than other participants. They should reinforce or build on the concepts from this project. Participants should not work ahead in the curriculum by starting on the next Topic Outline.
18 changes: 6 additions & 12 deletions _templates/topic-outline.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
### Projected Time

Example: 30-45 minutes

- Lesson: ? min
- Guided Practice: ?-? min
- Independent Practice: ? min
Expand All @@ -12,10 +13,8 @@ Example: 30-45 minutes

Here are topics that should be understood before this topic:


- Example: [Git version control](../git/git-version-control.md)


### Motivation

Why it is worth learning this topic
Expand All @@ -37,16 +36,15 @@ Why it is worth learning this topic
### Specific Things To Learn

- Focus on this specific talking point
- and this
- This is a sub-thing about the thing
- and this - This is a sub-thing about the thing
- Even more things about the things
- Even more things about the things

### Materials

- [Example video (10 min)](https://google.com) - Write a very short description of this resource.
- [Other example article(20 min read)](https://google.com) - Answer the 3 questions at the end.
(Be sure to explain how to use these materials in directions in one of the sections below (ie: lesson, guided practice). If you are not assigning them somehow, they should be placed under Supplemental Materials at the bottom.)
(Be sure to explain how to use these materials in directions in one of the sections below (ie: lesson, guided practice). If you are not assigning them somehow, they should be placed under Supplemental Materials at the bottom.)

### Lesson

Expand All @@ -59,26 +57,22 @@ Build on the first information. Have apprentices guess things, do an activity, e

Make sure to mention these things:

- Things
- This is a sub-thing
- Things - This is a sub-thing
- More things
- Even more things
- Even more things


### Common Mistakes & Misconceptions

List things that apprentices might not realize, might assume at first, or should avoid.

- Example
- Example


### Guided Practice

Have the apprentices work with you as you do something step-by-step. This can also be fulfilled by a detailed tutorial intended for beginners.


### Independent Practice

Class does this thing themselves with specific additional items. This could be alone, with a partner, or small group; but the idea is that it's less guided, more independent.
Expand All @@ -87,11 +81,11 @@ Class does this thing themselves with specific additional items. This could be a

Apprentices can try to do this other thing. Ideally, they will be challenged to connect what they've learned to some previous knowledge or additional research.


### Check for Understanding

Some ideas: have apprentices summarize to each other, make a cheat sheet, take a quiz, do an assignment, or something else that helps them self-assess their understanding. This exercise should help apprentices determine whether they've met the outline objectives, or if they need to review.
Some ideas: have apprentices summarize to each other, make a cheat sheet, take a quiz, do an assignment, or something else that helps them self-assess their understanding. This exercise should help apprentices determine whether they've met the outline objectives, or if they need to review.ss

### Supplemental Materials

- [example website](https://google.com) - Write a very short description of how to use this optional resource.
- [Other example website](https://google.com) - Write a very short description of how to use this optional resource.
Loading

0 comments on commit 752e3af

Please sign in to comment.