Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

reorganize chapters: add technology guides section #340

Merged
merged 4 commits into from
Oct 1, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,12 @@ If you are looking for an overall picture of best practices, read
[The Turing Way](https://the-turing-way.netlify.app/index.html) first.
We joined forces with that guide for most of our generic research software
engineering advice.
Because The Turing Way is language agnostic, this guide mostly provides
Because The Turing Way is programming language agnostic, this guide provides
addtional specific
[language guides](best_practices/language_guides/languages_overview.md).
*Please be aware that most remaining language agnostic content is outdated,
[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](/best_practices/overview.md) content is unmaintained,
be careful when using it.*
We plan on removing that content (#286).
We plan on removing that content ([#286](https://github.com/NLeSC/guide/issues/286)).

If you would like to contribute to this book see [CONTRIBUTING.md](CONTRIBUTING.md).
21 changes: 11 additions & 10 deletions _sidebar.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,20 @@

* [Introduction](/README.md)
* [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)
* [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)
* [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)
* [Contributing to this Guide](/CONTRIBUTING.md)
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
7 changes: 7 additions & 0 deletions technology/technology_overview.md
Original file line number Diff line number Diff line change
@@ -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).
File renamed without changes.
Loading