From ba71569bed196e8532d94a8b696dc0e03854a5eb Mon Sep 17 00:00:00 2001
From: Kostis Trantzas <ktrantzas@ece.upatras.gr>
Date: Fri, 21 Feb 2025 17:16:38 +0200
Subject: [PATCH] Moving documentation version update from documenting.md to
README.md
---
README.md | 10 ++++++++++
doc/contribute/documenting.md | 14 ++------------
2 files changed, 12 insertions(+), 12 deletions(-)
diff --git a/README.md b/README.md
index db18ccfa..004a1892 100644
--- a/README.md
+++ b/README.md
@@ -47,3 +47,13 @@ Please take a moment to understand the current structure of the documentations a
### Main Page
The page shown first is at **doc/index.md**. That page should be updated with the latest changes of OpenSlice and should reference the version (useful shortcut is ``{{{ documentation_version }}}``).
+
+### Release a New Version of the Documentation
+
+When **OpenSlice** code repository is ready for a new release, we need to follow these steps (made by a **TSC Member**):
+
+1. Create a MR from **develop** towards **main**;
+2. When **develop** is merged to **main**... then **create a tag with the released version** scheme... and you're done!
+
+[OSL Web]: https://osl.etsi.org/ "OSL Web"
+[OSL Documentation]: https://osl.etsi.org/documentation/ "OSL Documentation"
\ No newline at end of file
diff --git a/doc/contribute/documenting.md b/doc/contribute/documenting.md
index ad8963dd..84cb8aae 100644
--- a/doc/contribute/documenting.md
+++ b/doc/contribute/documenting.md
@@ -10,7 +10,7 @@ Documenting OpenSlice is limited to active contributors. So, if you:
2. wish to contribute to it;
3. you're ready!
-## System and Structure
+## System and Structure
[MkDocs](https://www.mkdocs.org/) is a fast and simple static site generator that's geared towards building project documentation. Documentation source files are written in `Markdown`, and configured with a single `YAML` configuration file. Start by reading the [introductory tutorial](https://www.mkdocs.org/getting-started/), then check the [User Guide](https://www.mkdocs.org/user-guide/) for more information.
@@ -75,16 +75,6 @@ To update the documentation properly during development, follow those additional
> The documentation website supports branches, so your accepted changes will be reflected to the **develop** branch which then becomes the **release** branch after each corresponding cycle.
-### Release a New Version of the Documentation
-
-When **OpenSlice** code repository is ready for a new release, we need to follow these steps (made by a **TSC Member**):
-
-1. Create a MR from **develop** towards **main**;
-2. When **develop** is merged to **main**... then **create a tag with the released version** scheme... and you're done!
-
-[OSL Web]: https://osl.etsi.org/ "OSL Web"
-[OSL Documentation]: https://osl.etsi.org/documentation/ "OSL Documentation"
-
## Learn more
-If you wish to learn more about the documentation system, check [this](https://labs.etsi.org/rep/osl/documentation/README.md) link.
\ No newline at end of file
+If you wish to learn more about the documentation system, check [this link](https://labs.etsi.org/rep/osl/documentation/README.md).
\ No newline at end of file
--
GitLab