From deb3ce93529c168707a8c27ba82347385d27122f Mon Sep 17 00:00:00 2001 From: Aleksandra Nenadic Date: Tue, 7 Jan 2025 13:22:12 +0000 Subject: [PATCH] Fix for related pages not showing. Fixes #88 --- pages/your_tasks/TEMPLATE_your_tasks.md | 3 ++- pages/your_tasks/codemeta.md | 3 ++- pages/your_tasks/creating_readthedocs.md | 3 ++- pages/your_tasks/environmental_sustainability.md | 3 ++- pages/your_tasks/how_to_make_a_good_readme.md | 3 ++- pages/your_tasks/languages_frameworks_technologies.md | 3 ++- pages/your_tasks/licensing_software.md | 3 ++- pages/your_tasks/readable_code.md | 3 ++- pages/your_tasks/releasing_code.md | 3 ++- pages/your_tasks/software_documentation.md | 7 ++----- pages/your_tasks/testing_code.md | 7 ++----- pages/your_tasks/version_control.md | 3 ++- pages/your_tasks/virtual_dev_environments.md | 3 ++- pages/your_tasks/zenodo_doi.md | 3 ++- 14 files changed, 28 insertions(+), 22 deletions(-) diff --git a/pages/your_tasks/TEMPLATE_your_tasks.md b/pages/your_tasks/TEMPLATE_your_tasks.md index 955b8b72..30a667e5 100644 --- a/pages/your_tasks/TEMPLATE_your_tasks.md +++ b/pages/your_tasks/TEMPLATE_your_tasks.md @@ -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: diff --git a/pages/your_tasks/codemeta.md b/pages/your_tasks/codemeta.md index 6eb134c2..db65d59a 100644 --- a/pages/your_tasks/codemeta.md +++ b/pages/your_tasks/codemeta.md @@ -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.) diff --git a/pages/your_tasks/creating_readthedocs.md b/pages/your_tasks/creating_readthedocs.md index f67ad8f5..baff36f9 100644 --- a/pages/your_tasks/creating_readthedocs.md +++ b/pages/your_tasks/creating_readthedocs.md @@ -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 diff --git a/pages/your_tasks/environmental_sustainability.md b/pages/your_tasks/environmental_sustainability.md index 6ac89a15..b9de97c9 100644 --- a/pages/your_tasks/environmental_sustainability.md +++ b/pages/your_tasks/environmental_sustainability.md @@ -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? diff --git a/pages/your_tasks/how_to_make_a_good_readme.md b/pages/your_tasks/how_to_make_a_good_readme.md index e49f6e09..87cb2c09 100644 --- a/pages/your_tasks/how_to_make_a_good_readme.md +++ b/pages/your_tasks/how_to_make_a_good_readme.md @@ -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? diff --git a/pages/your_tasks/languages_frameworks_technologies.md b/pages/your_tasks/languages_frameworks_technologies.md index 98658e59..ab97b767 100644 --- a/pages/your_tasks/languages_frameworks_technologies.md +++ b/pages/your_tasks/languages_frameworks_technologies.md @@ -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? diff --git a/pages/your_tasks/licensing_software.md b/pages/your_tasks/licensing_software.md index b15f714a..4b83c1f9 100644 --- a/pages/your_tasks/licensing_software.md +++ b/pages/your_tasks/licensing_software.md @@ -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? diff --git a/pages/your_tasks/readable_code.md b/pages/your_tasks/readable_code.md index d757f834..9fa04a0e 100644 --- a/pages/your_tasks/readable_code.md +++ b/pages/your_tasks/readable_code.md @@ -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: [] --- diff --git a/pages/your_tasks/releasing_code.md b/pages/your_tasks/releasing_code.md index c8871b67..91c009e3 100644 --- a/pages/your_tasks/releasing_code.md +++ b/pages/your_tasks/releasing_code.md @@ -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] --- diff --git a/pages/your_tasks/software_documentation.md b/pages/your_tasks/software_documentation.md index 493cb3c5..e3c92feb 100644 --- a/pages/your_tasks/software_documentation.md +++ b/pages/your_tasks/software_documentation.md @@ -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? diff --git a/pages/your_tasks/testing_code.md b/pages/your_tasks/testing_code.md index e651032d..95faa9df 100644 --- a/pages/your_tasks/testing_code.md +++ b/pages/your_tasks/testing_code.md @@ -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? diff --git a/pages/your_tasks/version_control.md b/pages/your_tasks/version_control.md index bfc468fb..99a80b26 100644 --- a/pages/your_tasks/version_control.md +++ b/pages/your_tasks/version_control.md @@ -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? diff --git a/pages/your_tasks/virtual_dev_environments.md b/pages/your_tasks/virtual_dev_environments.md index 6710493f..5b0cb86b 100644 --- a/pages/your_tasks/virtual_dev_environments.md +++ b/pages/your_tasks/virtual_dev_environments.md @@ -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? diff --git a/pages/your_tasks/zenodo_doi.md b/pages/your_tasks/zenodo_doi.md index 32c91f9c..b88aad4d 100644 --- a/pages/your_tasks/zenodo_doi.md +++ b/pages/your_tasks/zenodo_doi.md @@ -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?