Skip to content

Commit

Permalink
add page to the index
Browse files Browse the repository at this point in the history
and urls are not turned into links automatically like on github
  • Loading branch information
visr committed Oct 13, 2023
1 parent 1785dea commit 078e371
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 3 deletions.
1 change: 1 addition & 0 deletions docs/_quarto.yml
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ website:
- contribute/core.qmd
- contribute/python.qmd
- contribute/addnode.qmd
- contribute/release.qmd

format:
html:
Expand Down
6 changes: 3 additions & 3 deletions docs/contribute/release.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ The nightly download links for the Ribasim Python wheels contain the version num
Create a [new release](https://github.com/Deltares/Ribasim/releases/new).
Give it a tag like `v2023.08.0`, filling in the current year, month and a sequential "MICRO" number.
This follows `vYYYY.0M.MICRO` from [calver](https://calver.org/).
For [v2023.09.0](https://github.com/Deltares/Ribasim/releases/tag/v2023.09.0) I used the "Generate release notes" button, which I then manually edited to copy the most important changes for users to the top in the form of https://keepachangelog.com/en/1.0.0/.
For [v2023.09.0](https://github.com/Deltares/Ribasim/releases/tag/v2023.09.0) I used the "Generate release notes" button, which I then manually edited to copy the most important changes for users to the top in the form of [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
The possibly long list of generated release notes can put below an "All changes" collapsed item as such:

```
Expand Down Expand Up @@ -101,5 +101,5 @@ Now upload the files downloaded from S3 as mentioned in @sec-teamcity.
## Announce release

Announce the release in appropriate channels.
Include a link to the release notes and assets, which is whatever https://github.com/Deltares/Ribasim/releases/latest resolves to at that time.
Also include a link to the documentation: https://deltares.github.io/Ribasim/.
Include a link to the release notes and assets, which is whatever [this](https://github.com/Deltares/Ribasim/releases/latest) resolves to at that time.
Also include a link to the [documentation](https://deltares.github.io/Ribasim/).

0 comments on commit 078e371

Please sign in to comment.