Skip to content

Commit cbbc003

Browse files
authored
Merge pull request #414 from EVERSE-ResearchSoftware/anenadic-training-materials-for-tasks
Add training info/link to EVERSE TeSS to CI/CD task page
2 parents fd7daf6 + 836dead commit cbbc003

2 files changed

Lines changed: 15 additions & 2 deletions

File tree

pages/contributing/metadata_guidelines.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -81,8 +81,17 @@ in the "front matter" header of the page or applied to a group of pages via `_co
8181
* `datatable`: a boolean value indicating the activation of the pagination, sorting and searching in tabular representations of pages.
8282
* `related_pages`: a list of `page_id`s that are related to this page and will appear under "Related pages" section on the page, grouped by page type.
8383
* `page_citation`: When set to `true`, it will cause the citation section for the page to be generated in the format: "<author names>. <page title>. <site domain>. <page URL>. <date accessed>". Defaults to `true` for task pages; `false` for other page types.
84-
* `training`: a list of training entries, each having three properties - `name`, `registry` (which should be set to "EVERSE TeSS" - the only training registry currently supported) and `url` (see [more details on formatting](https://github.com/ELIXIR-Belgium/elixir-toolkit-theme/blob/main/pages/documentation/markdown_cheat_sheet.md#listing-training-material)).
85-
Training entries will show up under the "More information / Training" section on the page.
84+
* `training`: a list of training registry entries, each having three properties - `name`, `registry` and `url` - and taking the user to the external URL `url` within the registry that returns a certain set of training materials.
85+
For EVERSE TeSS training registry, the `registry` parameter should be set to "TeSS". Training registry entries will show up under the "More information | Training" section on the page.
86+
87+
An example of a training registry entry:
88+
89+
```yml
90+
training:
91+
- name: Training in EVERSE TeSS
92+
registry: TeSS
93+
url: https://everse-training.app.cern.ch/materials?q=%22ci%22+%22cd%22+%22ci%2Fcd%22+%22continuous+integration%22+%22continuous+deployment%22
94+
```
8695

8796
## Tools and resources metadata
8897

pages/your_tasks/ci_cd.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,10 @@ page_id: ci_cd
66
indicators: [software_has_ci-tests]
77
related_pages:
88
your_tasks: [task_automation_github_actions, task_automation_gitlab_ci_cd]
9+
training:
10+
- name: Training in EVERSE TeSS
11+
registry: TeSS
12+
url: https://everse-training.app.cern.ch/materials?q=%22ci%22+%22cd%22+%22ci%2Fcd%22+%22continuous+integration%22+%22continuous+deployment%22
913
---
1014

1115
## How can you use CI/CD in software development?

0 commit comments

Comments
 (0)