Skip to content

Commit 840b313

Browse files
committed
Replace broken links
1 parent f360637 commit 840b313

File tree

2 files changed

+20
-20
lines changed

2 files changed

+20
-20
lines changed

CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ The sections below outline the steps in each case.
2727

2828
## You want to make some kind of change to the code base
2929

30-
1. (**important**) this repository implements the best practices we recommend in the Python chapter of the [Guide](https://guide.esciencecenter.nl/#/best_practices/language_guides/python). Check that your planned contribution is
30+
1. (**important**) this repository implements the best practices we recommend in the Python chapter of the [Guide](https://guide.esciencecenter.nl/#/language_guides/python). Check that your planned contribution is
3131
in line with what is recommended there. If not, please [contribute to the guide](https://github.com/NLeSC/guide/blob/main/CONTRIBUTING.md) instead / as well, or at least create an issue there.
3232
1. (**important**) announce your plan to the rest of the community _before you start working_. This announcement should be in the form of a (new) issue;
3333
1. (**important**) wait until some kind of consensus is reached about your idea being a good idea;
@@ -54,4 +54,4 @@ To create a release you need write permission on the repository.
5454
1. Fill version, title and description field
5555
1. Press the Publish Release button
5656

57-
Also a Zenodo entry will be made for the release with its own DOI.
57+
Also a Zenodo entry will be made for the release with its own DOI.

template/project_setup.md.jinja

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Here we provide some details about the project setup. Most of the choices are ex
55
text when the development of the software package takes off.
66

77
For a quick reference on software development, we refer to [the software guide
8-
checklist](https://guide.esciencecenter.nl/#/best_practices/checklist).
8+
checklist](https://guide.esciencecenter.nl/#/best_practices?id=checklist).
99

1010
## Python versions
1111

@@ -16,23 +16,23 @@ This repository is set up with Python versions:
1616
- 3.12
1717

1818
Add or remove Python versions based on project requirements. See [the
19-
guide](https://guide.esciencecenter.nl/#/best_practices/language_guides/python) for more information about Python
19+
guide](https://guide.esciencecenter.nl/#/language_guides/python) for more information about Python
2020
versions.
2121

2222
## Package management and dependencies
2323

2424
You can use either pip or conda for installing dependencies and package management. This repository does not force you
2525
to use one or the other, as project requirements differ. For advice on what to use, please check [the relevant section
2626
of the
27-
guide](https://guide.esciencecenter.nl/#/best_practices/language_guides/python?id=dependencies-and-package-management).
27+
guide](https://guide.esciencecenter.nl/#/language_guides/python?id=dependencies-and-package-management).
2828

2929
- Runtime dependencies should be added to `pyproject.toml` in the `dependencies` list under `[project]`.
3030
- Development dependencies, such as for testing or documentation, should be added to `pyproject.toml` in one of the lists under `[project.optional-dependencies]`.
3131

3232
## Packaging/One command install
3333

3434
You can distribute your code using PyPI.
35-
[The guide](https://guide.esciencecenter.nl/#/best_practices/language_guides/python?id=building-and-packaging-code) can
35+
[The guide](https://guide.esciencecenter.nl/#/language_guides/python?id=building-and-packaging-code) can
3636
help you decide which tool to use for packaging.
3737

3838
{% if AddLocalTests -%}
@@ -47,7 +47,7 @@ help you decide which tool to use for packaging.
4747
- This is configured in `pyproject.toml`
4848
- The project uses [GitHub action workflows](https://docs.github.com/en/actions) to automatically run tests on GitHub infrastructure against multiple Python versions
4949
- Workflows can be found in [`.github/workflows`](.github/workflows/)
50-
- [Relevant section in the guide](https://guide.esciencecenter.nl/#/best_practices/language_guides/python?id=testing)
50+
- [Relevant section in the guide](https://guide.esciencecenter.nl/#/language_guides/python?id=testing)
5151
{%- endif %}
5252

5353
{% if AddLocalDocumentation -%}
@@ -61,69 +61,69 @@ help you decide which tool to use for packaging.
6161
- Check out its [configuration options](https://sphinx-rtd-theme.readthedocs.io/en/latest/).
6262
- [AutoAPI](https://sphinx-autoapi.readthedocs.io/) is used to generate documentation for the package Python objects.
6363
{% if AddOnlineDocumentation %}- `.readthedocs.yaml` is the ReadTheDocs configuration file. When ReadTheDocs is building the documentation this package and its development dependencies are installed so the API reference can be rendered.{% endif -%}
64-
- [Relevant section in the guide](https://guide.esciencecenter.nl/#/best_practices/language_guides/python?id=writingdocumentation)
64+
- [Relevant section in the guide](https://guide.esciencecenter.nl/#/language_guides/python?id=documentation)
6565
{%- endif %}
6666

6767
## Coding style conventions and code quality
6868

69-
- [Relevant section in the NLeSC guide](https://guide.esciencecenter.nl/#/best_practices/language_guides/python?id=coding-style-conventions) and [README.dev.md](README.dev.md).
69+
- [Relevant section in the NLeSC guide](https://guide.esciencecenter.nl/#/language_guides/python?id=coding-style-conventions) and [README.dev.md](README.dev.md).
7070

7171
{% if AddSonarCloud -%}
7272
## Continuous code quality
7373

74-
[Sonarcloud](https://sonarcloud.io/) is used to perform quality analysis and code coverage report
74+
[Sonarcloud](https://www.sonarsource.com/products/sonarcloud/) is used to perform quality analysis and code coverage report
7575

76-
- `sonar-project.properties` is the SonarCloud [configuration](https://docs.sonarqube.org/latest/analysis/analysis-parameters/) file
76+
- `sonar-project.properties` is the SonarCloud [configuration](https://docs.sonarsource.com/sonarqube-server/latest/analyzing-source-code/analysis-parameters/) file
7777
- `.github/workflows/sonarcloud.yml` is the GitHub action workflow which performs the SonarCloud analysis
7878
{%- endif %}
7979

8080
## Package version number
8181

82-
- We recommend using [semantic versioning](https://guide.esciencecenter.nl/#/best_practices/releases?id=semantic-versioning).
82+
- We recommend using [semantic versioning](https://packaging.python.org/en/latest/discussions/versioning/).
8383
- For convenience, the package version is stored in a single place: `pyproject.toml` under the `tool.bumpversion` header.
84-
- Don't forget to update the version number before [making a release](https://guide.esciencecenter.nl/#/best_practices/releases)!
84+
- Don't forget to update the version number before [making a release](https://guide.esciencecenter.nl/#/best_practices?id=releases)!
8585

8686
## Logging
8787

8888
- We recommend using the logging module for getting useful information from your module (instead of using print).
8989
- The project is set up with a logging example.
90-
- [Relevant section in the guide](https://guide.esciencecenter.nl/#/best_practices/language_guides/python?id=logging)
90+
- [Relevant section in the guide](https://guide.esciencecenter.nl/#/language_guides/python?id=logging)
9191

9292
{% if AddChangeLog -%}
9393
## CHANGELOG.md
9494

9595
- Document changes to your software package
96-
- [Relevant section in the guide](https://guide.esciencecenter.nl/#/best_practices/releases?id=changelogmd)
96+
- [Relevant section in the guide](https://guide.esciencecenter.nl/#/best_practices?id=releases)
9797
{%- endif %}
9898

9999
{% if AddCitation -%}
100100
## CITATION.cff
101101

102102
- To allow others to cite your software, add a `CITATION.cff` file
103103
- It only makes sense to do this once there is something to cite (e.g., a software release with a DOI).
104-
- Follow the [making software citable](https://guide.esciencecenter.nl/#/citable_software/making_software_citable) section in the guide.
104+
- Follow the [making software citable](https://book.the-turing-way.org/communication/citable/citable-steps) chapter of the Turing Way.
105105
{%- endif %}
106106

107107
{% if AddCodeConduct -%}
108108
## CODE_OF_CONDUCT.md
109109

110110
- Information about how to behave professionally
111-
- [Relevant section in the guide](https://guide.esciencecenter.nl/#/best_practices/documentation?id=code-of-conduct)
111+
- [Relevant section in the Turing Way](https://book.the-turing-way.org/reproducible-research/code-documentation/code-documentation-project#code-of-conduct)
112112
{%- endif %}
113113

114114
{% if AddContributing -%}
115115
## CONTRIBUTING.md
116116

117117
- Information about how to contribute to this software package
118-
- [Relevant section in the guide](https://guide.esciencecenter.nl/#/best_practices/documentation?id=contribution-guidelines)
118+
- [Relevant section in the Turing Way](https://book.the-turing-way.org/reproducible-research/code-documentation/code-documentation-project#contributing-guidelines)
119119
{%- endif %}
120120

121121
## MANIFEST.in
122122

123123
- List non-Python files that should be included in a source distribution
124-
- [Relevant section in the guide](https://guide.esciencecenter.nl/#/best_practices/language_guides/python?id=building-and-packaging-code)
124+
- [Relevant section in the guide](https://guide.esciencecenter.nl/#/language_guides/python?id=building-and-packaging-code)
125125

126126
## NOTICE
127127

128128
- List of attributions of this project and Apache-license dependencies
129-
- [Relevant section in the guide](https://guide.esciencecenter.nl/#/best_practices/licensing?id=notice)
129+
- [Relevant section on the Apache License documentation](https://infra.apache.org/licensing-howto.html#mod-notice)

0 commit comments

Comments
 (0)