Techtonica / curriculum

This repo contains the curriculum of Techtonica, a free tech training program for women and non-binary adults with low incomes.
Creative Commons Attribution Share Alike 4.0 International
617 stars 496 forks source link

Convert internal links to relative links #1128

Closed gsong closed 4 years ago

gsong commented 4 years ago

References to files and directories within this repo should be referenced via internal links, unless there's a good reason not to.

❌ Instead of:

[Data Models](https://github.com/Techtonica/curriculum/blob/master/databases/data-models.md)

✅ This:

[Data Models](./data-models.md)
List of problematic links ``` databases/sql-1.md 7:- [Data Models](https://github.com/Techtonica/curriculum/blob/master/databases/data-models.md) databases/mongoose.md 14:- [JSON](https://github.com/Techtonica/curriculum/blob/master/api/apis-and-json.md) databases/sql.md 7:- [Data Models](https://github.com/Techtonica/curriculum/blob/master/databases/sql.md) databases/relational-databases.md 247: - Execute a few queries to retrieve data, as guided by instructor or volunteers. (While this will likely be review of content from the [SQL](https://github.com/Techtonica/curriculum/blob/master/databases/sql.md) lesson plan, practice will help sharpen these skills.) databases/sql-2.md 7:- [Data Modeling 1](https://github.com/Techtonica/curriculum/blob/master/databases/data-modeling-1.md) 9:- [Data Modeling 2](https://github.com/Techtonica/curriculum/blob/master/databases/data-modeling-2.md) databases/mongo-db.md 15:- [JSON](https://github.com/Techtonica/curriculum/blob/master/api/apis-and-json.md) data-structures/linked-lists.md 178:See [Testing and TDD](https://github.com/Techtonica/curriculum/blob/master/testing-and-tdd/testing-and-tdd.md) for a refresher on how to use Mocha and Chai to write tests. css/reset-css.md 11:- [HTML Lesson](https://github.com/Techtonica/curriculum/blob/master/html/html.md) css/css.md 79:[Click here to access the instructions for the CSS portion of the recipe-page project](https://github.com/Techtonica/curriculum/blob/master/projects/recipe-page/phase-2-css-prompt.md). Please don't move on to the prompts for the other topics yet. 103:- Expand on CSS with [Sass](https://github.com/Techtonica/curriculum/blob/master/sass/sass.md) _templates/topic-outline.md 15:- Example: [Git version control](https://github.com/Techtonica/curriculum/blob/master/git-version-control/git-version-control.md) roles-in-tech/data-science.md 94:- [Python](https://github.com/Techtonica/curriculum/blob/master/python/python.md) roles-in-tech/machine-learning.md 12:- The main prerequisite for machine learning is [data analysis](https://github.com/Techtonica/curriculum/blob/master/roles-in-tech/data-science.md). 76:- Related topic: [Ethics in Software Engineering: Techtonica Outline](https://github.com/Techtonica/curriculum/blob/master/ethics/ethics.md) projects/data-structures-algorithms-sprint.md 33: Homework: read about your assigned data structures topics, highlight or outline the most important parts, and review runtime complexity ([topic outline](https://github.com/Techtonica/curriculum/blob/master/runtime-complexity/runtime-complexity.md), [slides](https://drive.google.com/open?id=1ZcOdekB_aP59huZdp4X0u6EfUJKgxzK7y8LqCmzSLC8), [video](https://drive.google.com/open?id=1ZoHxJMUiKOKPqu69vX3b_aeYGlDlRL6n)). projects/final-project/planning-your-project.md 35:![User flow example](https://github.com/Techtonica/curriculum/blob/master/projects/final-project/user-flow.png "User flow example") 45:![Wireframe example](https://github.com/Techtonica/curriculum/blob/master/projects/final-project/wireframe.png "Wireframe example") 54:![Data model schema](https://github.com/Techtonica/curriculum/blob/master/projects/final-project/data-model-schema.png "Data model schema") projects/final-project/final-project.md 68:- [ ] [Selecting Your Project](https://github.com/Techtonica/curriculum/blob/master/projects/final-project/selecting-your-project.md)—brainstorm ideas, check feasibility, and select one to build. 69:- [ ] [Planning Your Project](https://github.com/Techtonica/curriculum/blob/master/projects/final-project/planning-your-project.md)—plan and receive approval on your final project's: projects/eventonica/eventonica-react.md 5:* This is a follow-up to the [Eventonica project](https://github.com/Techtonica/curriculum/blob/eventonica-react/projects/eventonica-project.md) projects/eventonica/eventonica-project.md 4:- [SQL query](https://github.com/Techtonica/curriculum/blob/master/databases/sql.md) projects/minimal-api-project.md 5:- [Git](https://github.com/Techtonica/curriculum/blob/master/git-version-control/git-version-control.md) 6:- [bash](https://github.com/Techtonica/curriculum/blob/master/command-line/dot-profile.md) 7:- [SQL](https://github.com/Techtonica/curriculum/blob/master/databases/sql.md) projects/data-structures-algorithms-assessment.md 2:[(Assessment 11 Grader Guide)](https://github.com/Techtonica/curriculum/blob/master/assessment-objectives/11.md) projects/recipe-page/phase-1-html-prompt.md 44:Use the Terminal for navigating around the file system and creating new folders and files. Refer to the lesson on [The Command Line Interface](https://github.com/Techtonica/curriculum/blob/master/command-line/command-line-interface.md) if you need guidance on using the Terminal. 46: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://github.com/Techtonica/curriculum/blob/master/git-version-control/git-version-control.md) if you need guidance. 55:If you have questions, do not disturb your colleagues until you have spent at least 20 minutes troubleshooting on your own. Be sure to format your question using the template we practiced in the [Asking Good Questions](https://github.com/Techtonica/curriculum/blob/master/asking-good-questions/asking-good-questions.md) lesson. 81:![Image of webpage after creating title](https://github.com/Techtonica/curriculum/blob/master/projects/recipe-page/screenshots/step3-title.png) 92:![Image of webpage after adding blurb](https://github.com/Techtonica/curriculum/blob/master/projects/recipe-page/screenshots/step4-blurb.png) 101:![Image of webpage after adding ingredients](https://github.com/Techtonica/curriculum/blob/master/projects/recipe-page/screenshots/step5-ingredients.png) 118:![Image of webpage after adding instructions](https://github.com/Techtonica/curriculum/blob/master/projects/recipe-page/screenshots/step6-instructions.png) 146:![Image of finding image owner's URL](https://github.com/Techtonica/curriculum/blob/master/projects/recipe-page/screenshots/step7-photo-credit.png) 149:![Image of webpage after adding image and photo credit](https://github.com/Techtonica/curriculum/blob/master/projects/recipe-page/screenshots/step7-image.png) 161:![Image of webpage after adding links to similar recipes](https://github.com/Techtonica/curriculum/blob/master/projects/recipe-page/screenshots/step8-other-recipes.png) 179:![Intended layout of recipe webpage](https://github.com/Techtonica/curriculum/blob/master/projects/recipe-page/screenshots/intended_layout.png) projects/recipe-page/phase-2-css-prompt.md 43:Use the Terminal for navigating around the file system and creating new folders and files. Refer to the lesson on [The Command Line Interface](https://github.com/Techtonica/curriculum/blob/master/command-line/command-line-interface.md) if you need guidance on using the Terminal. 45: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://github.com/Techtonica/curriculum/blob/master/git-version-control/git-version-control.md) if you need guidance. 49:If you have questions, do not disturb your colleagues until you have spent at least 20 minutes troubleshooting on your own. Be sure to format your question using the template we practiced in the [Asking Good Questions](https://github.com/Techtonica/curriculum/blob/master/asking-good-questions/asking-good-questions.md) lesson. 92:![Webpage after making paragraph text blue](https://github.com/Techtonica/curriculum/blob/master/projects/recipe-page/screenshots/blue-blurb.png) 109:![Web page after changing the background color](https://github.com/Techtonica/curriculum/blob/master/projects/recipe-page/screenshots/background-color.png) 119:![Color picker drop-down menu](https://github.com/Techtonica/curriculum/blob/master/projects/recipe-page/screenshots/Screen%20Shot%202018-01-17%20at%203.05.48%20PM.png) 123:![After changing header colors](https://github.com/Techtonica/curriculum/blob/master/projects/recipe-page/screenshots/change-header-colors.png) 129:![Monoton Google Font](https://github.com/Techtonica/curriculum/blob/master/projects/recipe-page/screenshots/google-font-monoton.png) 133:![Google Font Selection](https://github.com/Techtonica/curriculum/blob/master/projects/recipe-page/screenshots/google-font-selection.png) 137:![Google Font Selection Expanded](https://github.com/Techtonica/curriculum/blob/master/projects/recipe-page/screenshots/google-font-selection-expanded.png) 141:![After importing Google Font](https://github.com/Techtonica/curriculum/blob/master/projects/recipe-page/screenshots/after-google-font-import.png) 158:![After limiting description to 600px](https://github.com/Techtonica/curriculum/blob/master/projects/recipe-page/screenshots/constrained-description.png) 166:We've already accomplished some initial steps for making this happen. We have the title and description in their own `
` which has a class called `top`. If we don't specify any layout styling for this div in `styles.css`, it just defaults to taking up the whole width of the screen. This is what we want, based on the layout image [shown in the instructions](https://github.com/Techtonica/curriculum/blob/master/projects/recipe-page/phase-1-html-prompt.md#part-9---add-some-divs-for-easy-css-integration-later). 176:![result of floating the left class](https://github.com/Techtonica/curriculum/blob/master/projects/recipe-page/screenshots/float-left-left.png) 188:![result of floating the right class on the left](https://github.com/Techtonica/curriculum/blob/master/projects/recipe-page/screenshots/float-left-right.png) 196:![complete](https://github.com/Techtonica/curriculum/blob/master/projects/recipe-page/screenshots/complete.png) projects/recipe-page/phase-3-bootstrap-prompt.md 40:Use the Terminal for navigating around the file system and creating new folders and files. Refer to the lesson on [The Command Line Interface](https://github.com/Techtonica/curriculum/blob/master/command-line/command-line-interface.md) if you need guidance on using the Terminal. 42: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://github.com/Techtonica/curriculum/blob/master/git-version-control/git-version-control.md) if you need guidance. 46:If you have questions, do not disturb your colleagues until you have spent at least 20 minutes troubleshooting on your own. Be sure to format your question using the template we practiced in the [Asking Good Questions](https://github.com/Techtonica/curriculum/blob/master/asking-good-questions/asking-good-questions.md) lesson. jquery/jquery.md 72:5. Read [this example code](https://github.com/Techtonica/curriculum/blob/master/jquery/jquery-programming-fundamentals/index.html) and talk through it with your pair partner. Once you understand what it does, copy it into `index.html` and save the file. 82:10. Read [this example code](https://github.com/Techtonica/curriculum/blob/master/jquery/jquery-programming-fundamentals/static/js/myScript.js) and talk through it with your pair partner. Once you understand what it does, copy it into `myScript.js` and save the file. objectives/5.md 3:Here are the concepts in [Assessment #5: Week 4 - Loops, Conditionals, Runtime Complexity](https://github.com/Techtonica/curriculum/blob/master/javascript/week-4-JS-assessment.md): objectives/4.md 34:](https://github.com/Techtonica/curriculum/blob/master/interviewing/week-3-whiteboard-challenges.md): objectives/1.md 3:Here are the concepts in [Assessment #1: Portfolio Project with HTML, CSS, Bootstrap](https://github.com/Techtonica/curriculum/blob/master/projects/portfolio/portfolio-webpage-1.md): objectives/0.md 3:These are the concepts in the [Week 1 Worksheet](https://github.com/Techtonica/curriculum/blob/master/projects/week-1-worksheet.md): objectives/10.md 2:[Assessment Outline: Advanced Methods: Assessment 10](https://github.com/Techtonica/curriculum/blob/master/projects/advanced-methods-assessment-10.md) objectives/7.md 35:[Week 6: Assessment 7.9 can be found here.](https://github.com/Techtonica/curriculum/blob/master/data-visualization/data-viz-assessment.md) objectives/3.md 4:](https://github.com/Techtonica/curriculum/blob/master/projects/portfolio/portfolio-webpage-3.md): objectives/6.md 2:[Assessment Outline: Restaurant Recommender System with JavaScript](https://github.com/Techtonica/curriculum/blob/master/javascript/restaurant%20recommender/RestaurantRecommender%20-%20part1.md) 10:[Assessment Outline: Restaurant Recommender System with JavaScript - Part 2](https://github.com/Techtonica/curriculum/blob/master/javascript/restaurant%20recommender/RestaurantRecommender-part2.md) README.md 19:- 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](https://github.com/Techtonica/curriculum/blob/master/_templates/topic-outline.md). 22: - 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](https://github.com/Techtonica/curriculum/blob/master/databases/mongo-db.md), [MongoDB Video](https://drive.google.com/file/d/1022MSkPjfRyGAUQa2I-pQltpUn4Q1NJc/view). 38:1. [Interpersonal Conflict Resolution](https://github.com/Techtonica/curriculum/blob/master/conflict-resolution/conflict-resolution.md) 39:1. [Diversity, Inclusion & Implicit Bias](https://github.com/Techtonica/curriculum/blob/master/diversity-inclusion-bias/inclusion.md) html/html.md 62:[Click here to access the instructions for the HTML portion of the project](https://github.com/Techtonica/curriculum/blob/master/projects/recipe-page/phase-1-html-prompt.md). Please don't move on to the prompts for the other topics yet. best-practice-in-development/best-practice-in-client-side-development.md 8:[HTML](https://github.com/Techtonica/curriculum/blob/master/html/html.md) and [CSS](https://github.com/Techtonica/curriculum/blob/master/css/css.md) command-line/vim.md 9:- [Command Line Interface](https://github.com/Techtonica/curriculum/blob/master/command-line/command-line-interface.md) objectives/2.md 4:](https://github.com/Techtonica/curriculum/blob/master/projects/portfolio/portfolio-webpage-2.md): command-line/command-line-interface.md 178:[Click here to learn more advanced commands](https://github.com/Techtonica/curriculum/blob/master/command-line/command-line-advanced.md). CONTRIBUTING.md 9:- 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](https://github.com/Techtonica/curriculum/blob/master/_templates/topic-outline.md). 12: - 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](https://github.com/Techtonica/curriculum/blob/master/databases/mongo-db.md), [MongoDB Video](https://drive.google.com/file/d/1022MSkPjfRyGAUQa2I-pQltpUn4Q1NJc/view). api/twilio-api.md 55:![alt text](https://github.com/Techtonica/curriculum/blob/master/api/Screen%20Shot%202018-10-08%20at%207.15.15%20PM.png) 61:![alt text](https://github.com/Techtonica/curriculum/blob/master/api/Screen%20Shot%202018-10-08%20at%207.26.01%20PM.png) 67:![alt text](https://github.com/Techtonica/curriculum/blob/master/api/Screen%20Shot%202018-10-08%20at%207.31.03%20PM.png) 73:![alt text](https://github.com/Techtonica/curriculum/blob/master/api/Screen%20Shot%202018-10-08%20at%207.44.02%20PM.png) 74:![alt text](https://github.com/Techtonica/curriculum/blob/master/api/Screen%20Shot%202018-10-08%20at%207.44.12%20PM.png) 75:![alt text](https://github.com/Techtonica/curriculum/blob/master/api/Screen%20Shot%202018-10-08%20at%207.44.22%20PM.png) professionalism/LinkedIn.md 15:- [Resume writing](https://github.com/Techtonica/curriculum/blob/master/resume-writing/resume-writing.md) javascript/javascript-7-oop.md 52:If you recall from [JavaScript 6 - Object Literals](https://github.com/Techtonica/curriculum/blob/master/javascript/javascript-6-object-literals.md)- ```
DekasDimitrios commented 4 years ago

Hello @gsong and @vegetabill, i would love to make an attempt on writing some code to automate this link manipulation system for the repository. Could that be useful for the project?

gsong commented 4 years ago

@DekasDimitrios Here's my opinion, if you want to write a script to manipulate the links in-place as a learning exercise, by all means, go for it. As a practical matter of how to solve this problem, a script is probably overkill.

In any case, however you end up getting the desired outcome is up to you, but the project probably doesn't need a script in the long term to keep internal links up to date, but instead will rely on code reviews to catch them.

If you think otherwise, I'm all ears. 😊

alodahl commented 4 years ago

this seems like more of a search/replace situation

habeeba-naaz commented 4 years ago

Hi...I am gssoc20 participant.I am very much interested to work on this issue...can you please assign me for this issue

alodahl commented 4 years ago

Thank you, that would be great! Would you please fill this form out for us before you start? https://docs.google.com/forms/d/e/1FAIpQLSeW0mo-Dpsig70374UEPvzexpas-31Ost_HsFwm0kjNOxtbtg/viewform?c=0&w=1

Srashtimittal commented 4 years ago

Hii, I am a gssoc20 participant .I want to contribute on this issue. Please assign me for this issue.

vegetabill commented 4 years ago

@habeeba-naaz thanks for volunteering. Are you still planning to work on this issue? I saw other comments from you on other issues. We are only going to assign a single issue at a time to volunteers. If you don't reply to this within 48 hours I will be putting it back as unassigned. You don't have to have it finished, just reply confirming it's the issue you will focus on first. Once you complete it, you can be assigned another.

habeeba-naaz commented 4 years ago

Thank you for assigning me...I completed form and completed assigned issue...so searching for other issues

habeeba-naaz commented 4 years ago

I was waiting to go for review on my issue until March 1st

Kundan28 commented 4 years ago

@habeeba-naaz You could start working now, as contribution period has started. Once you are done with this issue, comment on other one and we will assign you to that.