Skip to content

Commit

Permalink
documentation.md md fix
Browse files Browse the repository at this point in the history
  • Loading branch information
bclaremar authored Nov 21, 2024
1 parent 7f2b45c commit 2955e82
Showing 1 changed file with 4 additions and 5 deletions.
9 changes: 4 additions & 5 deletions docs/deployment/documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -134,14 +134,16 @@

- Think the same as for a scientific paper

**Our practical recommendations**:
**Practical recommendations**:

- Get a [DOI](https://en.wikipedia.org/wiki/Digital_object_identifier) using [Zenodo](https://zenodo.org) or similar services.
- Open source license can't demand citation, but it is required by science ethics anyway.
- Make it as easy as possible! Clearly say what you want cited.
- Make it easy for scripts and tools, use the [Citation File Format](https://citation-file-format.github.io).
- [GitHub now supports CITATION.cff files](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-citation-files)

This is an example of a simple `CITATION.cff` file:

```yaml
cff-version: 1.2.0
message: "If you use this software, please cite it as below."
Expand All @@ -157,6 +159,7 @@ date-released: 2021-08-11
Recommended format for software citation is to ensure the following information
is provided as part of the reference [Katz, Chue Hong, Clark, 2021](https://f1000research.com/articles/9-1257/v2):
- Creator

Check failure on line 163 in docs/deployment/documentation.md

View workflow job for this annotation

GitHub Actions / check_markdown

Trailing spaces [Expected: 0 or 2; Actual: 1]
- Title
- Publication venue
Expand All @@ -165,7 +168,6 @@ is provided as part of the reference [Katz, Chue Hong, Clark, 2021](https://f100
- Version
- Type
- Digital object identifiers (DOI) are the backbone of the academic reference and metrics system.

Check failure on line 171 in docs/deployment/documentation.md

View workflow job for this annotation

GitHub Actions / check_markdown

Trailing spaces [Expected: 0 or 2; Actual: 1]
- CodeRefinery has an exercise to see how to make a GitHub repository citable by archiving it on the Zenodo archiving service. If you are interested, have a look [here](https://coderefinery.github.io/github-without-command-line/doi/#making-your-project-citable)
Expand Down Expand Up @@ -213,9 +215,6 @@ is provided as part of the reference [Katz, Chue Hong, Clark, 2021](https://f100
## Licensing
!!! info "See also"
[Extra material about licensing](https://uppmax.github.io/programming_formalisms_intro/sharing_deeper.html#licensing)
Expand Down

0 comments on commit 2955e82

Please sign in to comment.