From 268f780bd9d8921ce4494d059c2a75aff65eae46 Mon Sep 17 00:00:00 2001 From: Bouwe Andela Date: Wed, 1 Nov 2023 17:57:55 +0100 Subject: [PATCH 1/2] Move chapter owners to page maintainers --- CONTRIBUTING.md | 5 ++-- _sidebar.md | 1 - best_practices/language_guides/bash.md | 3 +++ best_practices/language_guides/ccpp.md | 2 ++ best_practices/language_guides/fortran.md | 3 +++ best_practices/language_guides/javascript.md | 3 +++ .../language_guides/languages_overview.md | 3 +++ best_practices/language_guides/opencl_cuda.md | 3 +++ best_practices/language_guides/python.md | 3 +++ best_practices/language_guides/r.md | 3 +++ best_practices/user_experience.md | 3 +++ chapter_owners.md | 25 ------------------- 12 files changed, 29 insertions(+), 28 deletions(-) delete mode 100644 chapter_owners.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6b340ae8..1abfdc7e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -45,9 +45,10 @@ If everything works as it should, ``git add``, ``commit`` and ``push`` like norm If you have made a significant contribution to the guide, please make sure to add yourself to the `CITATION.cff` file so your name can be included in the list of authors of the guide. -## Chapter Owners +## Page maintainers -To see who is responsible for which part of the guide see [chapter_owners.md](chapter_owners.md). +To see who is responsible for which part of the guide see the maintainer listed at the bottom of a page. +If you are interested in becoming a chapter owner for a page that is listed as *unmaintained*, please open a pull request to add your name instead of *unmaintained*. ## Create a PDF file diff --git a/_sidebar.md b/_sidebar.md index b3e11f5e..8663c474 100644 --- a/_sidebar.md +++ b/_sidebar.md @@ -32,7 +32,6 @@ * [Examples](/intellectual_property_and_licensing/examples.md) * [Contributing to this Guide](/CONTRIBUTING.md) * NLeSC specific - * [Chapter Owners](/chapter_owners.md) * [Access to (Dutch) e-Infrastructure](/nlesc_specific/e-infrastructure/e-infrastructure.md) * [DAS-5](/nlesc_specific/e-infrastructure/das5.md) * [Projects](/nlesc_specific/projects/project_overview.md) diff --git a/best_practices/language_guides/bash.md b/best_practices/language_guides/bash.md index c1f1db2c..d3b0d654 100644 --- a/best_practices/language_guides/bash.md +++ b/best_practices/language_guides/bash.md @@ -200,3 +200,6 @@ set -e - [Bash Cheat sheet](https://devhints.io/bash) - The [Bash Reference Manual](https://www.gnu.org/savannah-checkouts/gnu/bash/manual/bash.html) or use `man bash` - [Oh My Zsh](https://ohmyz.sh/) offers an extensive set of themes and shortcuts for the Zsh + + +*Page maintainer: Bouwe Andela* [@bouweandela](https://github.com/bouweandela) diff --git a/best_practices/language_guides/ccpp.md b/best_practices/language_guides/ccpp.md index 23725821..b0680189 100644 --- a/best_practices/language_guides/ccpp.md +++ b/best_practices/language_guides/ccpp.md @@ -326,3 +326,5 @@ A newer but less mature option is [cldoc](http://jessevdk.github.io/cldoc/). * Bjarne Soustrup - The C++ Language * Scott Meyers - Effective Modern C++ + +*Page maintainers: Johan Hidding* [@jhidding](https://github.com/jhidding) *and Patrick Bos* [@egpbos](https://github.com/egpbos) diff --git a/best_practices/language_guides/fortran.md b/best_practices/language_guides/fortran.md index 64e9ee92..eeccae7a 100644 --- a/best_practices/language_guides/fortran.md +++ b/best_practices/language_guides/fortran.md @@ -40,3 +40,6 @@ standard conventions, described in the [official documentation](http://www.fortr * Add concise comments to modules and routines, and add comments to less obvious lines of code. * Provide a test suite with your code, containing both unit and integration tests. Both automake and cmake provide test suite functionality; if you create your makefile yourself, add a separate testing target. + + +*Page maintainer: Gijs van den Oord* [@goord](https://github.com/goord) diff --git a/best_practices/language_guides/javascript.md b/best_practices/language_guides/javascript.md index 44d9992e..0d3b6223 100644 --- a/best_practices/language_guides/javascript.md +++ b/best_practices/language_guides/javascript.md @@ -230,3 +230,6 @@ Alternative could be [TSdoc](https://www.npmjs.com/package/tsdoc) [TSLint](https://github.com/palantir/tslint) is a good tool to check your codestyle. For the [sim-city-cs project](https://github.com/indodutch/sim-city-cs/) we use [this](https://github.com/ReGIS-org/regis/blob/develop/tslint.json) tslint.json file. + + +*Page maintainer: Jurriaan Spaaks* [@jspaaks](https://github.com/jspaaks) diff --git a/best_practices/language_guides/languages_overview.md b/best_practices/language_guides/languages_overview.md index 04368f5f..491130b2 100644 --- a/best_practices/language_guides/languages_overview.md +++ b/best_practices/language_guides/languages_overview.md @@ -44,3 +44,6 @@ Highly recommented to get some inspiration on available tools and libraries! To do development in any language you first need infrastructure (code hosting, ci, etc). Luckily a lot is available for free now. See this list: https://github.com/ripienaar/free-for-dev + + +*Page maintainer: unmaintained* diff --git a/best_practices/language_guides/opencl_cuda.md b/best_practices/language_guides/opencl_cuda.md index 9df56169..fe9fb467 100644 --- a/best_practices/language_guides/opencl_cuda.md +++ b/best_practices/language_guides/opencl_cuda.md @@ -65,3 +65,6 @@ * Generic Auto Tuners: * [Kernel Tuner](https://github.com/benvanwerkhoven/kernel_tuner) (Python) * [CLTune](https://github.com/CNugteren/CLTune) (C++) + + +*Page maintainer: unmaintained* diff --git a/best_practices/language_guides/python.md b/best_practices/language_guides/python.md index c8dff8ae..c0bf7436 100644 --- a/best_practices/language_guides/python.md +++ b/best_practices/language_guides/python.md @@ -325,3 +325,6 @@ We recommend `flask`. * For run-time configuration via command-line options, the built-in [`argparse`](https://docs.python.org/library/argparse.html) module usually suffices. * A more complete solution is [`ConfigArgParse`](https://github.com/bw2/ConfigArgParse). This (almost) drop-in replacement for `argparse` allows you to not only specify configuration options via command-line options, but also via (ini or yaml) configuration files and via environment variables. * Other popular libraries are [`click`](https://click.palletsprojects.com) and [`fire`](https://google.github.io/python-fire/). + + +*Page maintainer: Patrick Bos* [@egpbos](https://github.com/egpbos) diff --git a/best_practices/language_guides/r.md b/best_practices/language_guides/r.md index 42ac0e6b..fe060066 100644 --- a/best_practices/language_guides/r.md +++ b/best_practices/language_guides/r.md @@ -131,3 +131,6 @@ Debugging is possible in RStudio, see [link](https://support.rstudio.com/hc/en-u # Not in this tutorial yet: * Logging + + +*Page maintainer: unmaintained* diff --git a/best_practices/user_experience.md b/best_practices/user_experience.md index 0317e274..9e426bf9 100644 --- a/best_practices/user_experience.md +++ b/best_practices/user_experience.md @@ -67,3 +67,6 @@ Design tools used for Visual Design, Prototyping, and IxD testing collaborative, * [Figma](https://www.figma.com/) * [Miro](https://miro.com/) * [Whimsical](https://whimsical.com/) + + +*Page maintainer: Jesus Garcia* [@ctwhome](https://github.com/ctwhome) diff --git a/chapter_owners.md b/chapter_owners.md deleted file mode 100644 index 507a3a71..00000000 --- a/chapter_owners.md +++ /dev/null @@ -1,25 +0,0 @@ -# Chapter Owners - -This is a list of who is responsible for which part of the guide. - -Overall Maintainer: Bouwe Andela - -* Introduction: Jason Maassen - -* Software Development: - * Overall: Jason Maassen - * Code Review: Lourens Veen -* Language Guides: - * Introduction: Jason Maassen - * JavaScript and TypeScript: Jurriaan Spaaks - * Python: Patrick Bos - * OpenCL and CUDA: Ben van Werkhoven - * R: Vincent van Hees - * C and C++: Johan Hidding and Patrick Bos - * Fortran: Gijs van den Oord - * UX: Jesus Garcia -* Intellectual Property: Lourens Veen -* Publishing Scientific Results: Willem van Hage -* Access to e-Infrastructure: Jason Maassen -* Projects: Jisk Attema -* Contributing to this Guide: Jason Maassen From ca79bf1f9d0d90110058a349a66d5916bf72b7b3 Mon Sep 17 00:00:00 2001 From: Bouwe Andela Date: Thu, 2 Nov 2023 09:39:29 +0100 Subject: [PATCH 2/2] Move page maintainers to top of page Replace bottom by top --- CONTRIBUTING.md | 2 +- best_practices/language_guides/bash.md | 6 +++--- best_practices/language_guides/ccpp.md | 6 +++--- best_practices/language_guides/fortran.md | 6 +++--- best_practices/language_guides/javascript.md | 6 +++--- best_practices/language_guides/languages_overview.md | 7 ++++--- best_practices/language_guides/opencl_cuda.md | 5 ++--- best_practices/language_guides/python.md | 6 +++--- best_practices/language_guides/r.md | 7 ++++--- best_practices/user_experience.md | 7 +++---- 10 files changed, 29 insertions(+), 29 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1abfdc7e..68d540d4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -47,7 +47,7 @@ If you have made a significant contribution to the guide, please make sure to ad ## Page maintainers -To see who is responsible for which part of the guide see the maintainer listed at the bottom of a page. +To see who is responsible for which part of the guide see the maintainer listed at the top of a page. If you are interested in becoming a chapter owner for a page that is listed as *unmaintained*, please open a pull request to add your name instead of *unmaintained*. ## Create a PDF file diff --git a/best_practices/language_guides/bash.md b/best_practices/language_guides/bash.md index d3b0d654..67f30610 100644 --- a/best_practices/language_guides/bash.md +++ b/best_practices/language_guides/bash.md @@ -1,5 +1,8 @@ # Bash +*Page maintainer: Bouwe Andela* [@bouweandela](https://github.com/bouweandela) + + Bash is both a command line interface, also known as a **shell**, and a scripting language. On most Linux distributions, the Bash shell is the default way of interacting @@ -200,6 +203,3 @@ set -e - [Bash Cheat sheet](https://devhints.io/bash) - The [Bash Reference Manual](https://www.gnu.org/savannah-checkouts/gnu/bash/manual/bash.html) or use `man bash` - [Oh My Zsh](https://ohmyz.sh/) offers an extensive set of themes and shortcuts for the Zsh - - -*Page maintainer: Bouwe Andela* [@bouweandela](https://github.com/bouweandela) diff --git a/best_practices/language_guides/ccpp.md b/best_practices/language_guides/ccpp.md index b0680189..7138c1d0 100644 --- a/best_practices/language_guides/ccpp.md +++ b/best_practices/language_guides/ccpp.md @@ -1,5 +1,8 @@ # C and C++ +*Page maintainers: Johan Hidding* [@jhidding](https://github.com/jhidding) *and Patrick Bos* [@egpbos](https://github.com/egpbos) + + C++ is one of the hardest languages to learn. Entering a project where C++ coding is needed should not be taken lightly. This guide focusses on tools and documentation for use of C++ in an open-source environment. ### Standards @@ -325,6 +328,3 @@ A newer but less mature option is [cldoc](http://jessevdk.github.io/cldoc/). ### Books * Bjarne Soustrup - The C++ Language * Scott Meyers - Effective Modern C++ - - -*Page maintainers: Johan Hidding* [@jhidding](https://github.com/jhidding) *and Patrick Bos* [@egpbos](https://github.com/egpbos) diff --git a/best_practices/language_guides/fortran.md b/best_practices/language_guides/fortran.md index eeccae7a..36d352b3 100644 --- a/best_practices/language_guides/fortran.md +++ b/best_practices/language_guides/fortran.md @@ -1,5 +1,8 @@ # Fortran +*Page maintainer: Gijs van den Oord* [@goord](https://github.com/goord) + + **Disclaimer: In general the Netherlands eScience Center does not recommend using Fortran. However, in some cases it is the only viable option, for instance if a project builds upon existing code written in this language. This section will be restricted to Fortran90, which captures majority of Fortran source code.** The second use case may be extremely performance-critical dense @@ -40,6 +43,3 @@ standard conventions, described in the [official documentation](http://www.fortr * Add concise comments to modules and routines, and add comments to less obvious lines of code. * Provide a test suite with your code, containing both unit and integration tests. Both automake and cmake provide test suite functionality; if you create your makefile yourself, add a separate testing target. - - -*Page maintainer: Gijs van den Oord* [@goord](https://github.com/goord) diff --git a/best_practices/language_guides/javascript.md b/best_practices/language_guides/javascript.md index 0d3b6223..a973c806 100644 --- a/best_practices/language_guides/javascript.md +++ b/best_practices/language_guides/javascript.md @@ -1,5 +1,8 @@ # Getting started +*Page maintainer: Jurriaan Spaaks* [@jspaaks](https://github.com/jspaaks) + + To learn about JavaScript, view the presentations by [Douglas Crockford](http://en.wikipedia.org/wiki/Douglas_crockford): * [Crockford on JavaScript](http://www.youtube.com/playlist?list=PL7664379246A246CB) @@ -230,6 +233,3 @@ Alternative could be [TSdoc](https://www.npmjs.com/package/tsdoc) [TSLint](https://github.com/palantir/tslint) is a good tool to check your codestyle. For the [sim-city-cs project](https://github.com/indodutch/sim-city-cs/) we use [this](https://github.com/ReGIS-org/regis/blob/develop/tslint.json) tslint.json file. - - -*Page maintainer: Jurriaan Spaaks* [@jspaaks](https://github.com/jspaaks) diff --git a/best_practices/language_guides/languages_overview.md b/best_practices/language_guides/languages_overview.md index 491130b2..e252eba6 100644 --- a/best_practices/language_guides/languages_overview.md +++ b/best_practices/language_guides/languages_overview.md @@ -1,3 +1,7 @@ + +*Page maintainer: unmaintained* + + This chapter provides practical info on each of the main programming languages of the Netherlands eScience Center. This info is (on purpose) high level, try to provide "default" options, and mostly link to more info. @@ -44,6 +48,3 @@ Highly recommented to get some inspiration on available tools and libraries! To do development in any language you first need infrastructure (code hosting, ci, etc). Luckily a lot is available for free now. See this list: https://github.com/ripienaar/free-for-dev - - -*Page maintainer: unmaintained* diff --git a/best_practices/language_guides/opencl_cuda.md b/best_practices/language_guides/opencl_cuda.md index fe9fb467..d3555a23 100644 --- a/best_practices/language_guides/opencl_cuda.md +++ b/best_practices/language_guides/opencl_cuda.md @@ -1,5 +1,7 @@ # OpenCL & CUDA +*Page maintainer: Alessio Sclocco* [@isazi](https://github.com/isazi) + ## Sources for learning *please add university courses and informative videos* @@ -65,6 +67,3 @@ * Generic Auto Tuners: * [Kernel Tuner](https://github.com/benvanwerkhoven/kernel_tuner) (Python) * [CLTune](https://github.com/CNugteren/CLTune) (C++) - - -*Page maintainer: unmaintained* diff --git a/best_practices/language_guides/python.md b/best_practices/language_guides/python.md index c0bf7436..e48b683a 100644 --- a/best_practices/language_guides/python.md +++ b/best_practices/language_guides/python.md @@ -1,5 +1,8 @@ # Python +*Page maintainer: Patrick Bos* [@egpbos](https://github.com/egpbos) + + Python is the "dynamic language of choice" of the Netherlands eScience Center. We use it for data analysis and data science projects using the SciPy stack and Jupyter notebooks, and for [many other types of projects](https://github.com/NLeSC?language=python): workflow management, visualization, NLP, web-based tools and much more. It is a good default choice for many kinds of projects due to its generic nature, its large and broad ecosystem of third-party modules and its compact syntax which allows for rapid prototyping. @@ -325,6 +328,3 @@ We recommend `flask`. * For run-time configuration via command-line options, the built-in [`argparse`](https://docs.python.org/library/argparse.html) module usually suffices. * A more complete solution is [`ConfigArgParse`](https://github.com/bw2/ConfigArgParse). This (almost) drop-in replacement for `argparse` allows you to not only specify configuration options via command-line options, but also via (ini or yaml) configuration files and via environment variables. * Other popular libraries are [`click`](https://click.palletsprojects.com) and [`fire`](https://google.github.io/python-fire/). - - -*Page maintainer: Patrick Bos* [@egpbos](https://github.com/egpbos) diff --git a/best_practices/language_guides/r.md b/best_practices/language_guides/r.md index fe060066..a8ab8c7b 100644 --- a/best_practices/language_guides/r.md +++ b/best_practices/language_guides/r.md @@ -1,4 +1,8 @@ # What is R? + +*Page maintainer: unmaintained* + + R is a functional programming language and software environment for statistical computing and graphics: https://www.r-project.org/. ## Philosophy and typical use cases @@ -131,6 +135,3 @@ Debugging is possible in RStudio, see [link](https://support.rstudio.com/hc/en-u # Not in this tutorial yet: * Logging - - -*Page maintainer: unmaintained* diff --git a/best_practices/user_experience.md b/best_practices/user_experience.md index 9e426bf9..1fa775dc 100644 --- a/best_practices/user_experience.md +++ b/best_practices/user_experience.md @@ -1,6 +1,8 @@ - # User Experience (UX) +*Page maintainer: Jesus Garcia* [@ctwhome](https://github.com/ctwhome) + + User Experience Design (UX) is a broad, holistic science that combines many cognitive and brain sciences disciplines like psychology and sociology, content strategies, and arts and aesthetics by following human-center approaches. > Human-centred design is an approach to interactive systems development that aims to make systems usable and useful by focusing on the users, their needs and requirements, and applying human factors/ergonomics and usability knowledge and techniques. This approach enhances effectiveness and efficiency, improves human well-being, user satisfaction, accessibility, sustainability, and counteracts possible adverse effects on human health, safety, and performance. [HCDSociety](https://human-centered-design.org/about/) @@ -67,6 +69,3 @@ Design tools used for Visual Design, Prototyping, and IxD testing collaborative, * [Figma](https://www.figma.com/) * [Miro](https://miro.com/) * [Whimsical](https://whimsical.com/) - - -*Page maintainer: Jesus Garcia* [@ctwhome](https://github.com/ctwhome)