Skip to content

Commit

Permalink
Fix for related pages not showing. Fixes #88
Browse files Browse the repository at this point in the history
  • Loading branch information
anenadic committed Jan 7, 2025
1 parent bd79de0 commit deb3ce9
Show file tree
Hide file tree
Showing 14 changed files with 28 additions and 22 deletions.
3 changes: 2 additions & 1 deletion pages/your_tasks/TEMPLATE_your_tasks.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@ search_exclude: true # set to false if you want this page to show up in search r
description: "" # a description of the page
contributors: [] # a comma separated list of contributors' names, as found in _data/CONTRIBUTORS.yml
page_id: # unique page id, e.g. lowercase title words separated by underscore(s) - for example page_id of 'version control' page could be version_control
related_pages: [] # A comma-separated page_ids of the pages that are related to the current page
related_pages:
your_tasks: [] # A comma-separated page_ids of the task pages that are related to the current page
training: # A list of training resources relevant for this task or problem (e.g from TeSS registry or elsewhere)
- name:
registry:
Expand Down
3 changes: 2 additions & 1 deletion pages/your_tasks/codemeta.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@ title: Writing a CodeMeta file
description: What is CodeMeta and how to write a CodeMeta file for your software
contributors: ["Daniel Garijo"]
page_id: codemeta
related_pages: [zenodo_doi]
related_pages:
your_tasks: [zenodo_doi]
---
## What is CodeMeta?
[CodeMeta](https://codemeta.github.io/terms/) is a community standard for interchanging software metadata records. It consists on a set of properties that extend [Schema.org](https://schema.org) (a popular vocabulary designed to describe Digital Objects on the Web) with software-specific metadata (e.g., maintainer, build instructions, software documentation, etc.)
Expand Down
3 changes: 2 additions & 1 deletion pages/your_tasks/creating_readthedocs.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@ title: "Creating a 'Read the Docs' Page"
description: How to create 'Read the Docs' pages to describe software
contributors: ["Christian Hüser","Azza Gamgami"]
page_id: creating_readthedocs
related_pages: [Software_documentation]
related_pages:
your_tasks: [Software_documentation]
---

## How to Create a ReadTheDocs Page
Expand Down
3 changes: 2 additions & 1 deletion pages/your_tasks/environmental_sustainability.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@ title: Environmental sustainability of research software
description: Guide to improving environmental sustainability of software
contributors: ["Kirsty Pringle"]
page_id: environmental_sustainability
related_pages: []
related_pages:
your_tasks: []
---

## How to monitor and reduce the environmental impact of my software?
Expand Down
3 changes: 2 additions & 1 deletion pages/your_tasks/how_to_make_a_good_readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@ title: Creating README documents for software
description: How to make a good README document for research software projects
contributors: ["Esteban González", "Aleksandra Nenadic", "Daniel Garijo"]
page_id: how_to_make_a_good_readme
related_pages: []
related_pages:
your_tasks: []
---

## Why is it important to have a good README file?
Expand Down
3 changes: 2 additions & 1 deletion pages/your_tasks/languages_frameworks_technologies.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@ title: Languages, frameworks & technologies
description: How to decide on which programming languages, frameworks and technologies to use, and getting started with templates
contributors: ["Patrick Bos"]
page_id: languages_frameworks_technologies
related_pages: [three_tier_view, life_cycle, fair, research_software_engineer]
related_pages:
your_tasks: [three_tier_view, life_cycle, fair, research_software_engineer]
---

## How to choose programming languages, frameworks and technologies?
Expand Down
3 changes: 2 additions & 1 deletion pages/your_tasks/licensing_software.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@ title: Licensing software
description: How to apply a license to research software
contributors: ["Daniel Garijo", "Aleksandra Nenadic", "Shoaib Sufi", "Thomas Vuillaume"]
page_id: licensing_software
related_pages: []
related_pages:
your_tasks: []
---

## What is copyright and licensing?
Expand Down
3 changes: 2 additions & 1 deletion pages/your_tasks/readable_code.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@ title: Writing readable code
description: How to write code readable and understandable by others
contributors: ["Aleksandra Nenadic"]
page_id: readable_code
related_pages: []
related_pages:
your_tasks: []
---


Expand Down
3 changes: 2 additions & 1 deletion pages/your_tasks/releasing_code.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@ title: Releasing code
description: How to create software releases
contributors: ["Christian Hüser", "Shoaib Sufi", "Daniel Garijo"]
page_id: releasing_code
related_pages: [zenodo_doi]
related_pages:
your_tasks: [zenodo_doi]

---

Expand Down
7 changes: 2 additions & 5 deletions pages/your_tasks/software_documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,8 @@ title: Software documentation
description: How to write clear and useful software documentation for developers and end-users
contributors: ["Azza Gamgami"]
page_id: software_documentation
related_pages: [creating_readthedocs, how_to_make_a_good_readme]
training:
- name:
registry:
url:
related_pages:
your_tasks: [creating_readthedocs, how_to_make_a_good_readme]
---

## How to create good software documentation?
Expand Down
7 changes: 2 additions & 5 deletions pages/your_tasks/testing_code.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,8 @@ title: Testing code
description: Why and how to test your code
contributors: ["Aleksandra Nenadic", "Christian Hüser"]
page_id: testing_code
related_pages: []
training:
- name:
registry:
url:
related_pages:
your_tasks: []
---

## What is code testing?
Expand Down
3 changes: 2 additions & 1 deletion pages/your_tasks/version_control.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@ title: Version control
description: Version control systems in research software engineering
contributors: ["Giacomo Peru"]
page_id: version_control
related_pages: []
related_pages:
your_tasks: []
---

## How do I choose the right version control system for my research project?
Expand Down
3 changes: 2 additions & 1 deletion pages/your_tasks/virtual_dev_environments.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@ title: Reproducible virtual software development environments
description: What are virtual software development environments for reproducible research and how to use them?
contributors: ["Aleksandra Nenadic"]
page_id: virtual_environments
related_pages: []
related_pages:
your_tasks: []
---

## What are virtual software development environments?
Expand Down
3 changes: 2 additions & 1 deletion pages/your_tasks/zenodo_doi.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@ title: Digital Software Identifiers (DOI) for Software
description: Obtaining a DOI via Zenodo for software
contributors: ["Shoaib Sufi", "Daniel Garijo"]
page_id: zenodo_doi
related_pages: [releasing_code]
related_pages:
your_tasks: [releasing_code]
---

## What is a Digital Object Identifier?
Expand Down

0 comments on commit deb3ce9

Please sign in to comment.