From bf5814ae80cd4b6b21c257bb8623aea94c088184 Mon Sep 17 00:00:00 2001 From: Timothy Slade Date: Sat, 19 Oct 2019 20:20:44 -0700 Subject: [PATCH] Updated broken links listed in #163, and a couple others. --- README.md | 4 ++-- .../reproducible-software/README.md | 8 ++++---- sources/dssg-manual/summer-overview/README.md | 2 +- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 2c92b9b8..ea759561 100644 --- a/README.md +++ b/README.md @@ -12,9 +12,9 @@ In addition to hands-on project-based training, the summer program also consists The primary audience for this guide is the set of fellows coming to DSSG but we want everything we create to be open and accessible to larger world. We hope this is useful to people beyond the summer fellows coming to DSSG. -**If you are applying to the program or have been accepted as a fellow,** [check out the manual](dssg-manual/) to see how you can prepare before arriving, what orientation and training will cover, and what to expect from the summer. +**If you are applying to the program or have been accepted as a fellow,** [check out the manual](sources/dssg-manual/README.md) to see how you can prepare before arriving, what orientation and training will cover, and what to expect from the summer. -**If you are interested in learning at home,** check out the [tutorials and teach-outs](curriculum/) developed by our staff and fellows throughout the summer, and to suggest or contribute additional resources. +**If you are interested in learning at home,** check out the [tutorials and teach-outs](sources/curriculum/README.md) developed by our staff and fellows throughout the summer, and to suggest or contribute additional resources. *Another one of our goals is to encourage collaborations. Anyone interested in doing this type of work, or starting a DSSG program, to build on what we've learned by **using and contributing to** these resources. diff --git a/sources/curriculum/programming_best_practices/reproducible-software/README.md b/sources/curriculum/programming_best_practices/reproducible-software/README.md index 4a34c3db..f0eedf46 100644 --- a/sources/curriculum/programming_best_practices/reproducible-software/README.md +++ b/sources/curriculum/programming_best_practices/reproducible-software/README.md @@ -58,18 +58,18 @@ Examples: # What to Do - Use [virtual environments](#virtual-environments). -- [Use automation tools like Make or Drake](https://github.com/dssg/hitchhikers-guide/tree/master/tech-tutorials/reproducible_ETL) +- [Use automation tools like Make or Drake](https://github.com/dssg/hitchhikers-guide/tree/master/sources/curriculum/1_getting_and_keeping_data/reproducible_ETL) - Keep your directory structure [intuitive, interpretable and easy to understand](#good-directory-organization). - Keep your database free of "junk tables." Keep only what you need and what's current. - Junk tables will only confuse your future-self or others that come fresh to the project. - Merge all branches into master. - Branches are for adding features or patches. When you have added said feature or patch and you know you won't break the master branch, merge into master and delete the branch. -- Write commit messages in such a way that your log is helpful (see [Git and Github tutorial](https://github.com/dssg/hitchhikers-guide/tree/master/tech-tutorials/git-and-github).) +- Write commit messages in such a way that your log is helpful (see [Git and Github tutorial](https://github.com/dssg/hitchhikers-guide/tree/master/sources/curriculum/setup/git-and-github).) - [Periodically make database backups](#backup-your-database). - Write unit tests and use continuous integration so you can catch bugs quickly, particularly when you are merging - new features into master. (See [testing tutorial](https://github.com/dssg/hitchhikers-guide/tree/master/tech-tutorials/test-test-test).) -- Document all of your functions with docstrings. (See [legible, good code tutorial](https://github.com/dssg/hitchhikers-guide/tree/master/tech-tutorials/legible-good-code).) + new features into master. (See [testing tutorial](https://github.com/dssg/hitchhikers-guide/tree/master/sources/curriculum/programming_best_practices/test-test-test).) +- Document all of your functions with docstrings. (See [legible, good code tutorial](https://github.com/dssg/hitchhikers-guide/tree/master/sources/curriculum/programming_best_practices/legible-good-code).) - Write your python code following the PEP8 standard. (See [legible, good code tutorial](https://github.com/dssg/hitchhikers-guide/tree/master/tech-tutorials/legible-good-code).) - Use (4) spaces instead of tabs in your Python code for indentation. diff --git a/sources/dssg-manual/summer-overview/README.md b/sources/dssg-manual/summer-overview/README.md index 23c31294..792411d7 100644 --- a/sources/dssg-manual/summer-overview/README.md +++ b/sources/dssg-manual/summer-overview/README.md @@ -190,7 +190,7 @@ few weeks off with an [intensive orientation](DSSG2016OrientationSchedule.pdf), - [CSV to DB](/curriculum/1_getting_and_keeping_data/csv-to-db/) - Legal Agreements - [Data Security Primer](/curriculum/1_getting_and_keeping_data/data-security-primer/) - - [Legible, Good Code](/curriculum/4_programming_best_practices/legible-good-code/) + - [Legible, Good Code](/curriculum/programming_best_practices/legible-good-code/) - [Conduct, Culture, and Communications](../conduct-culture-and-communications/README.md) - **Week Three** - [Reproducible ETL](/curriculum/1_getting_and_keeping_data/reproducible-ETL/)