diff --git a/README.md b/README.md index b8b17a17..c686d857 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,7 @@ Because The Turing Way is programming language agnostic, this guide provides addtional specific [language guides](language_guides/languages_overview.md). We also provide [technology guides](technology/technology_overview.md) on digital technologies we use often in our projects with research partners. -*Please be aware that most remaining "best practices" content is unmaintained, +*Please be aware that most remaining [best practices](/best_practices/overview.md) content is unmaintained, be careful when using it.* We plan on removing that content ([#286](https://github.com/NLeSC/guide/issues/286)). diff --git a/_sidebar.md b/_sidebar.md index 300268fa..a9d8ca80 100644 --- a/_sidebar.md +++ b/_sidebar.md @@ -1,11 +1,5 @@ * [Introduction](/README.md) -* [Best practices](/best_practices/overview.md) - * [Code Quality](/best_practices/code_quality.md) - * [Code Review](/best_practices/code_review.md) - * [Releases](/best_practices/releases.md) - * [Documentation](/best_practices/documentation.md) - * [Standards](/best_practices/standards.md) * [Language Guides](/language_guides/languages_overview.md) * [Bash](/language_guides/bash.md) * [JavaScript and TypeScript](/language_guides/javascript.md) @@ -17,4 +11,10 @@ * [GPU programming](/technology/gpu.md) * [UX - User Experience](/technology/user_experience.md) * [Datasets](/technology/datasets.md) +* [Best practices](/best_practices/overview.md) + * [Code Quality](/best_practices/code_quality.md) + * [Code Review](/best_practices/code_review.md) + * [Releases](/best_practices/releases.md) + * [Documentation](/best_practices/documentation.md) + * [Standards](/best_practices/standards.md) * [Contributing to this Guide](/CONTRIBUTING.md)