From 078e371a4eab62f8f4d4df9eaa559217d864b577 Mon Sep 17 00:00:00 2001 From: Martijn Visser Date: Fri, 13 Oct 2023 15:25:47 +0200 Subject: [PATCH] add page to the index and urls are not turned into links automatically like on github --- docs/_quarto.yml | 1 + docs/contribute/release.qmd | 6 +++--- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/_quarto.yml b/docs/_quarto.yml index cd60d14a0..9f7b2891a 100644 --- a/docs/_quarto.yml +++ b/docs/_quarto.yml @@ -48,6 +48,7 @@ website: - contribute/core.qmd - contribute/python.qmd - contribute/addnode.qmd + - contribute/release.qmd format: html: diff --git a/docs/contribute/release.qmd b/docs/contribute/release.qmd index 06f81814e..86c2ac085 100644 --- a/docs/contribute/release.qmd +++ b/docs/contribute/release.qmd @@ -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: ``` @@ -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/).