reorganize chapters: add technology guides section

Also moved language guides to the root folder level, because I find it annoying to have to click into the best_practices folder. Note: datasets still has to be moved to technologies, but there is an outstanding PR on that and I don't want to stress git's ability to detect moved files too much, otherwise we lose the ability to easily browse edit history.
NLeSC · Sep 25, 2024 · 6ed8e70 · 6ed8e70
1 parent e98e815
commit 6ed8e70
Show file tree

Hide file tree

Showing 11 changed files with 19 additions and 10 deletions.
diff --git a/_sidebar.md b/_sidebar.md
@@ -6,14 +6,16 @@
    * [Releases](/best_practices/releases.md)
    * [Documentation](/best_practices/documentation.md)
    * [Standards](/best_practices/standards.md)
-   * [UX - User Experience](/best_practices/user_experience.md)
-   * [Datasets](/best_practices/datasets.md)
-   * [Language Guides](/best_practices/language_guides/languages_overview.md)
-      * [Bash](/best_practices/language_guides/bash.md)
-      * [JavaScript and TypeScript](/best_practices/language_guides/javascript.md)
-      * [Python](/best_practices/language_guides/python.md)
-      * [GPU](/best_practices/language_guides/opencl_cuda.md)
-      * [R](/best_practices/language_guides/r.md)
-      * [C and C++](/best_practices/language_guides/ccpp.md)
-      * [Fortran](/best_practices/language_guides/fortran.md)
+   * [Datasets](/best_practices/datasets.md) <!-- Move down after https://github.com/NLeSC/guide/pull/339 is merged -->
+* [Language Guides](/language_guides/languages_overview.md)
+   * [Bash](/language_guides/bash.md)
+   * [JavaScript and TypeScript](/language_guides/javascript.md)
+   * [Python](/language_guides/python.md)
+   * [R](/language_guides/r.md)
+   * [C and C++](/language_guides/ccpp.md)
+   * [Fortran](/language_guides/fortran.md)
+* [Technology Guides](/technology/technology_overview.md)
+   * [GPU programming](/technology/gpu.md)
+   * [UX - User Experience](/technology/user_experience.md)
+   <!-- Move datasets here after https://github.com/NLeSC/guide/pull/339 is merged -->
 * [Contributing to this Guide](/CONTRIBUTING.md)
diff --git a/best_practices/language_guides/bash.md → language_guides/bash.md b/best_practices/language_guides/bash.md → language_guides/bash.md
diff --git a/best_practices/language_guides/ccpp.md → language_guides/ccpp.md b/best_practices/language_guides/ccpp.md → language_guides/ccpp.md
diff --git a/best_practices/language_guides/fortran.md → language_guides/fortran.md b/best_practices/language_guides/fortran.md → language_guides/fortran.md
diff --git a/best_practices/language_guides/javascript.md → language_guides/javascript.md b/best_practices/language_guides/javascript.md → language_guides/javascript.md
diff --git a/...ces/language_guides/languages_overview.md → language_guides/languages_overview.md b/...ces/language_guides/languages_overview.md → language_guides/languages_overview.md
diff --git a/best_practices/language_guides/python.md → language_guides/python.md b/best_practices/language_guides/python.md → language_guides/python.md
diff --git a/best_practices/language_guides/r.md → language_guides/r.md b/best_practices/language_guides/r.md → language_guides/r.md
diff --git a/..._practices/language_guides/opencl_cuda.md → technology/gpu.md b/..._practices/language_guides/opencl_cuda.md → technology/gpu.md
diff --git a/technology/technology_overview.md b/technology/technology_overview.md
@@ -0,0 +1,7 @@
+*Page maintainer: Patrick Bos* [@egpbos](https://github.com/egpbos)
+
+These chapters are based on our experiences with using specific software technologies.
+
+The main audience is RSEs familiar with basic computing and programming concepts.
+
+The purpose of these chapters is for someone unfamiliar with the specific technology to get a quick overview of the most important concepts, practices and tools, without going into too much detail (we provide links to further reading material for more).
diff --git a/best_practices/user_experience.md → technology/user_experience.md b/best_practices/user_experience.md → technology/user_experience.md