From d64a191efcf9c86457471d19f8bd45ded9668f98 Mon Sep 17 00:00:00 2001 From: AdamBelloum Date: Tue, 10 Dec 2024 12:19:47 +0100 Subject: [PATCH] update the README file --- README.md | 62 ++++++++++++++++++------------------------------------- 1 file changed, 20 insertions(+), 42 deletions(-) diff --git a/README.md b/README.md index 79d0875..8de54ab 100644 --- a/README.md +++ b/README.md @@ -1,44 +1,22 @@ -# NEBULA-content-template -This template repository can be used to create an easily maintainable, version-controllable, web-based lesson collection to be deployed with the [NEBULA framework](https://github.com/esciencecenter-digital-skills/NEBULA). - -## Repo instantiation -To create a custom-made lesson repository, click the `Use this template` button located at the top right of this page. - -## Configure GitHub Pages -After instantiation, you need to set up your repo's GitHub Pages. Follow these steps: -- Go to `Settings` (located on the top toolbar), and then click on `Pages`. -- Under the `Branch` option, select the `gh-pages` branch and then click `Save`. Use the `/root` folder as the default. -- Return to your main repository page. -- In the `About` section of your repository details, find the `Website` field and select `Use your GitHub Pages website`. - -## Add the title of your lesson and additional sections -This can be configured through the `config.json` file. Below is an example of its contents: -``` -{ - "publicProps": { - "title": "Add a title for your lesson/project", - "baseURL": "NEBULA-content-template", - "repoName": "NEBULA-content-template", - "repoOwner": "esciencecenter-digital-skills", - "organization": "Netherlands eScience Center", - "categoryOrder": ["Category1", "Category2"] - } -} -``` -You can modify the `"title"` field to reflect your specific topic and add new sections to your lesson under `"categoryOrder"`. - -The `"repoName"` and `"baseURL"` fields are automatically updated to the name of your new repository using the [generate_config.yml](https://github.com/esciencecenter-digital-skills/NEBULA-content-template/blob/main/.github/workflows/generate_config.yml) file. The corresponding workflow is triggered only once upon repository instantiation and is subsequently disabled. - -## Adding new modules -This repository includes dummy model modules as templates that you can follow to create your own modules. Please, follow the recommended formats and file extensions. -See also [NEBULA-docs](https://github.com/esciencecenter-digital-skills/NEBULA-docs) for information on how to create new modules. - -## Suggestions and further info -Suggestions are always welcome. -For this and any other issues, we invite you contribute to the project by creating `Issues` and `Pull requests`. -If needed, you can also contact us directly: -- Carlos M. R. Rocha: c.rocha@esciencecenter.nl -- Jaro Camphuijsen: j.camphuijsen@esciencecenter.nl -- Robin Richardson: r.richardson@esciencecenter.nl + +# Internal Training for Research Software Engineers +The training programme aims to help RSEs learn the fundamental computer science and engineering concepts and shows how these concepts can impact performance, correctness, quality, and reusability of the research software they work on. The programme provides RSEs with relevant fundamental background knowledge on topics that have a direct impact on their daily work. The training program is customized for each RSE depending on the background, and the skills needed for projects on which the SRE is working: + + - **Module 1**: Introduction to computer science and software engineering + - **Module 2**: Code Quality & Documentation + - **Module 3**: Collaborative Development + - **Module 4**: Open-Source Software (OSS) + +Internal training is provided both for onboarding new RSEs and for helping current RSEs develop new skills needed for their daily work at the center. The internal training sessions are offered in individual or group formats under the coaching of one of the Tech Leads. Please always discuss your interest in participating in internal training with your line manager. + +​Please contact "TechLeads" if you have any further questions. + +## Contributing +We welcome contributions to the content of the Research Software Support platform. Please view [the contributing guidelines](https://github.com/esciencecenter-digital-skills/research-software-support/blob/main/CONTRIBUTING.md) for more information. + +## Technical documentation +This platform uses the [NEBULA framework](https://github.com/esciencecenter-digital-skills/NEBULA). + +For elaborate setup instructions and other documentation, see the [NEBULA documentation](https://github.com/esciencecenter-digital-skills/NEBULA-docs)