add links on readme to research docs #15
Conversation
matthewdking
requested review from
rinoma,
veredrec,
tyeung2017,
Heathercoraje,
a user,
KatiaAsh,
sajedazoabi and
Wyrd00
README.md
Outdated
| ## Week 5 - Node 2 | ||
|
|
||
| ## Week 6 - Postgres | ||
|
|
||
| + [Build Scripts](./week-66/build_scripts.md) |
There was a problem hiding this comment.
fix week-66
I think you intended: week-6
README.md
Outdated
| ## Week 5 - Node 2 | ||
|
|
||
| ## Week 6 - Postgres | ||
|
|
||
| + [Build Scripts](./week-66/build_scripts.md) | ||
|
|
||
| + [Script Injections](./week-6/script-injection.md) |
There was a problem hiding this comment.
Remember to also change the folder's name to week-6, the same goes for week-7
README.md
Outdated
|
|
||
| ## Week 8 - Express | ||
|
|
||
| + [Sessions](./week8/sessions.md) | ||
|
|
||
| + [Fetch and Promises](./week8/fetch-promises-research.md) |
There was a problem hiding this comment.
This link is not broken,
Because although you did not change the folder's name(as per week6 and week7),
You also did not change the name of the folder when you referenced it in this link(wheras you linked a week-6, week-66, and week-7, which did not exist)
Although this works, when you do a large project and hand it over to someone else, not following some sort of naming consistency would make it more difficult for the next person to continue your work.
Google "Naming Convention" or "Universal Naming Convention"
A naming consistency adds clarity and uniformity that helps everyone to remember, understand, and visually scan your code, and even for searching your code.
Some word processing programs can filter, highlight, and edit names that have certain qualities in them (eg, hyphens), which makes it significantly easier to make quick edits that would have otherwise demanded many long and complicated edits that you'd have to search hard and carefully in order to even find
I advise changing the link to week-8 as well as changing the folder's name to week-8
There was a problem hiding this comment.
@HilbertSpitzer good point! Made some changes
There was a problem hiding this comment.
It's late to say this now but...
With regards to the line with "Unit vs Integration testing"
The real name of the md file has a space instead of a hyphen, so the link given here doesn't work.
To solve this, you can
1.
Link the md file with "Unit%20vs%20Integration%20Testing.md"
URLs can't contain spaces. So URL encoding normally replaces a space with a plus (+) sign or with %20.
Or...
2.
You can change the name of the md file itself so that it would contain a hyphen instead of a space, which is what I personally prefer
The same problem exists with another week2 link, the "Software development methodologies" link.
The link for "Technical Spikes" also does not work.
Because the md file is called "technical-spike" instead of "technical-spikes"
relates #14