diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6b340ae8..68d540d4 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 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/_sidebar.md b/_sidebar.md index b3250243..66eec357 100644 --- a/_sidebar.md +++ b/_sidebar.md @@ -20,6 +20,5 @@ * [Fortran](/best_practices/language_guides/fortran.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) diff --git a/best_practices/language_guides/bash.md b/best_practices/language_guides/bash.md index c1f1db2c..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 diff --git a/best_practices/language_guides/ccpp.md b/best_practices/language_guides/ccpp.md index 23725821..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,4 +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++ - diff --git a/best_practices/language_guides/fortran.md b/best_practices/language_guides/fortran.md index 64e9ee92..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 diff --git a/best_practices/language_guides/javascript.md b/best_practices/language_guides/javascript.md index 44d9992e..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) diff --git a/best_practices/language_guides/languages_overview.md b/best_practices/language_guides/languages_overview.md index 04368f5f..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. diff --git a/best_practices/language_guides/opencl_cuda.md b/best_practices/language_guides/opencl_cuda.md index 9df56169..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* diff --git a/best_practices/language_guides/python.md b/best_practices/language_guides/python.md index c8dff8ae..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. diff --git a/best_practices/language_guides/r.md b/best_practices/language_guides/r.md index 42ac0e6b..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 diff --git a/best_practices/user_experience.md b/best_practices/user_experience.md index 0317e274..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/) 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