From a6aa12369d3c36e7d7ca92aa043a6543416c3346 Mon Sep 17 00:00:00 2001 From: Mehdi Nassim KHODJA <18899702+naskio@users.noreply.github.com> Date: Wed, 20 Dec 2023 12:58:47 +0100 Subject: [PATCH] add Updating Documentation section to release-process (#292) Co-authored-by: Marcin Krystianc --- docs/docs/3-contributing/6-release-process.mdx | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/docs/docs/3-contributing/6-release-process.mdx b/docs/docs/3-contributing/6-release-process.mdx index 58d9ccd9e..051985eaa 100644 --- a/docs/docs/3-contributing/6-release-process.mdx +++ b/docs/docs/3-contributing/6-release-process.mdx @@ -7,6 +7,15 @@ Be aware, clicking **Publish** will trigger GitHub to push a new tag (as specified in the new Release entry, if not created by you already) which will instruct the CI to build and push a new stable release to NuGet.org. 5. If everything went well, congrats, the new versions should be live on NuGet by now. As a final post-release step, bump the minor version in `Directory.Build.props` to the next unreleased version number, so that nightly build versioning can benefit. +## Updating Documentation + +Please ensure that you review and update the documentation when making a new release. More specifically: +1. In [README.md](https://github.com/G-Research/consuldotnet/blob/master/README.md) + - Consul API version. + - .NET Framework and .NET Core supported versions. +2. In [docusaurus.config.js](https://github.com/G-Research/consuldotnet/blob/master/docs/docusaurus.config.js) + - .NET Framework and .NET Core supported versions. + ## Versioning The version number indicates which version of Consul is supported in terms of API features.