From 3537189a3a7d2390f0b4cf1e36fdf2d32f241681 Mon Sep 17 00:00:00 2001 From: shahmargi12 <124675506+shahmargi12@users.noreply.github.com> Date: Thu, 10 Oct 2024 14:01:16 +0530 Subject: [PATCH] docs: align docs structure with TRG1 (#343) https://github.com/eclipse-tractusx/portal-shared-components/issues/315 --- docs/README.md | 7 +++++++ docs/{ => admin}/release-process/release-process.md | 2 +- 2 files changed, 8 insertions(+), 1 deletion(-) create mode 100644 docs/README.md rename docs/{ => admin}/release-process/release-process.md (98%) diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 00000000..a8953e8f --- /dev/null +++ b/docs/README.md @@ -0,0 +1,7 @@ +# Portal Shared Component Documentation + +This documentation provides guidelines and information for understanding and working with the **Portal Shared Component**. It includes the following document: + +1. [**Release process**](./admin/release-process/release-process.md) + + The release process is divided into several steps to ensure that versioning, changelog updates, and publishing are conducted systematically. diff --git a/docs/release-process/release-process.md b/docs/admin/release-process/release-process.md similarity index 98% rename from docs/release-process/release-process.md rename to docs/admin/release-process/release-process.md index c2af072f..ac1570b5 100644 --- a/docs/release-process/release-process.md +++ b/docs/admin/release-process/release-process.md @@ -58,7 +58,7 @@ If the workflow is executed manually and there is no release commit but the pack ## Release Process Flow Diagram -![Project Diagram](../static/release-process.png) +![Project Diagram](../../static/release-process.png) ## Reference Documents