From c9fcd13526fdb4d5bed8d15d1b5497f66393c6fb Mon Sep 17 00:00:00 2001 From: Fabian Gruen Date: Tue, 12 Dec 2023 09:18:59 +0100 Subject: [PATCH 1/7] docs: add trg 2-4 leading readme example --- docs/release/trg-2/trg-2-4.md | 19 +++++++++++++++---- 1 file changed, 15 insertions(+), 4 deletions(-) diff --git a/docs/release/trg-2/trg-2-4.md b/docs/release/trg-2/trg-2-4.md index 298021f53bb4..90dd21e2491c 100644 --- a/docs/release/trg-2/trg-2-4.md +++ b/docs/release/trg-2/trg-2-4.md @@ -2,10 +2,11 @@ title: TRG 2.04 - Leading product repository --- -| Status | Created | Post-History | -|--------|-------------|-----------------| -| Active | 07-Mar-2023 | | -| | 10-Jan-2023 | Initial release | +| Status | Created | Post-History | +|--------|-------------|------------------------------------------------| +| Update | 12-Dez-2023 | add example leading repository reference links | +| Active | 07-Mar-2023 | | +| | 10-Jan-2023 | Initial release | ## Why @@ -21,6 +22,8 @@ A good example when a product has a separate repository for frontend and backend - productname: leading product repository - README.md: contains the urls for the backend and frontend applications + - README.md: each repo follows our [TRG 1.01](../trg-1/trg-1-1.md) about the README.md + - README.md: an [example](#readme-example-section-for-a-leading-product-repository) for a leading product repository - contains the release of the product - contains the [product helm chart](../trg-5/trg-5-08) - productname-A-frontend: the repository for the frontend application @@ -33,3 +36,11 @@ A good example when a product has a separate repository for frontend and backend - README.md contains the description of what the product does - README.md contains the references/urls to the product's other repositories if they exist - It **should** contain the [TRG 5.08 - Product Helm Chart](https://eclipse-tractusx.github.io/docs/release/trg-5/trg-5-08) + +### README example section for a leading product repository + +```markdown +Leading repository for [product-name](link_to_product_repository): +- [product component A](link_to_product_component_A_repository) +- [product component B](link_to_product_component_B_repository) +``` From e9ee477cefaa6631913a3c025257b3f8eb290ab5 Mon Sep 17 00:00:00 2001 From: Fabian Gruen Date: Wed, 13 Dec 2023 08:55:23 +0100 Subject: [PATCH 2/7] docs: rephrasing repo example declaration --- docs/release/trg-2/trg-2-4.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/release/trg-2/trg-2-4.md b/docs/release/trg-2/trg-2-4.md index 90dd21e2491c..683a859f67bd 100644 --- a/docs/release/trg-2/trg-2-4.md +++ b/docs/release/trg-2/trg-2-4.md @@ -10,7 +10,7 @@ title: TRG 2.04 - Leading product repository ## Why -We have multiply stakeholders for a repository: System team, release management, test management, external people who are trying it out, want to contribute or need to set it up. +We have multiply stakeholders for a repository: system team, release management, test management, external people who are trying it out, want to contribute or need to set it up. They need to be able to understand complicated product structures in an intuitive way to have an easier task of diving into a product. ## Description @@ -18,16 +18,16 @@ They need to be able to understand complicated product structures in an intuitiv Each product **must** have a leading product repository that can point the users to all the parts/components/charts/releases of that product. This can be achieved by having a single repository for a product or creating references to the other repositories. -A good example when a product has a separate repository for frontend and backend. Then the product team **must** have a leading repository where they reference the components/repositories of the product: +Good product examples have separate repositories for each component (e.g. frontend and backend). Then the product team **must** have a leading repository where they reference the components/repositories of the product: - productname: leading product repository - - README.md: contains the urls for the backend and frontend applications + - README.md: contains the urls for e.g. the backend and frontend applications - README.md: each repo follows our [TRG 1.01](../trg-1/trg-1-1.md) about the README.md - - README.md: an [example](#readme-example-section-for-a-leading-product-repository) for a leading product repository + - README.md: an [example section](#readme-example-section-for-a-leading-product-repository) for a leading product repository - contains the release of the product - contains the [product helm chart](../trg-5/trg-5-08) -- productname-A-frontend: the repository for the frontend application -- productname-A-backend: the repository for the backend application +- productname-a-component: e.g. the repository for the frontend application +- productname-b-component: e.g. the repository for the backend application ## Leading product repository rules From 75f1fb2bf834ea5b7f43fe08b5043cc8fa7a8700 Mon Sep 17 00:00:00 2001 From: Fabian Gruen Date: Wed, 13 Dec 2023 11:13:01 +0100 Subject: [PATCH 3/7] docs: rephrasing leading repo description --- docs/release/trg-2/trg-2-4.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/docs/release/trg-2/trg-2-4.md b/docs/release/trg-2/trg-2-4.md index 683a859f67bd..86abf70f93e1 100644 --- a/docs/release/trg-2/trg-2-4.md +++ b/docs/release/trg-2/trg-2-4.md @@ -15,10 +15,14 @@ They need to be able to understand complicated product structures in an intuitiv ## Description -Each product **must** have a leading product repository that can point the users to all the parts/components/charts/releases of that product. +Each product **must** have a leading product repository that points to all the parts/components/charts/releases of the product. This can be achieved by having a single repository for a product or creating references to the other repositories. -Good product examples have separate repositories for each component (e.g. frontend and backend). Then the product team **must** have a leading repository where they reference the components/repositories of the product: +Good examples of products got separate repositories for each component (e.g. frontend and backend). + +The product **must** have a leading repository where they reference the components/repositories of the product: + +Exemplary repository structure: - productname: leading product repository - README.md: contains the urls for e.g. the backend and frontend applications @@ -29,6 +33,8 @@ Good product examples have separate repositories for each component (e.g. fronte - productname-a-component: e.g. the repository for the frontend application - productname-b-component: e.g. the repository for the backend application +And each repo **must** contain the metafile see [TRG 2.05](../trg-2/trg-2-5.md). + ## Leading product repository rules - The name of the leading product repository **must** contain the product name without prefix or suffix From efc7f724495fe8088b6d4d2f2588292b1c6f4d2d Mon Sep 17 00:00:00 2001 From: Fabian Gruen Date: Wed, 13 Dec 2023 11:13:34 +0100 Subject: [PATCH 4/7] chore: adpat branch changes to trg1.4 --- docs/release/{trg-0 => trg-1}/trg-1-4.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename docs/release/{trg-0 => trg-1}/trg-1-4.md (100%) diff --git a/docs/release/trg-0/trg-1-4.md b/docs/release/trg-1/trg-1-4.md similarity index 100% rename from docs/release/trg-0/trg-1-4.md rename to docs/release/trg-1/trg-1-4.md From 6d1bdb2ddb0f607fae53a875d68eb018db5809be Mon Sep 17 00:00:00 2001 From: Fabian Gruen Date: Mon, 18 Dec 2023 13:38:52 +0100 Subject: [PATCH 5/7] docs: reword + typo multiple + clear doubled entries --- docs/release/trg-2/trg-2-4.md | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/docs/release/trg-2/trg-2-4.md b/docs/release/trg-2/trg-2-4.md index 86abf70f93e1..800c13586422 100644 --- a/docs/release/trg-2/trg-2-4.md +++ b/docs/release/trg-2/trg-2-4.md @@ -10,7 +10,7 @@ title: TRG 2.04 - Leading product repository ## Why -We have multiply stakeholders for a repository: system team, release management, test management, external people who are trying it out, want to contribute or need to set it up. +We have multiple stakeholders for a repository: system team, release management, test management, external people who are trying it out, want to contribute or need to set it up. They need to be able to understand complicated product structures in an intuitive way to have an easier task of diving into a product. ## Description @@ -18,10 +18,6 @@ They need to be able to understand complicated product structures in an intuitiv Each product **must** have a leading product repository that points to all the parts/components/charts/releases of the product. This can be achieved by having a single repository for a product or creating references to the other repositories. -Good examples of products got separate repositories for each component (e.g. frontend and backend). - -The product **must** have a leading repository where they reference the components/repositories of the product: - Exemplary repository structure: - productname: leading product repository From 9730695e42a8c04c8343391c9012f08863750815 Mon Sep 17 00:00:00 2001 From: Fabian Gruen Date: Tue, 19 Dec 2023 08:29:05 +0100 Subject: [PATCH 6/7] docs: reword external contributor + URLs --- docs/release/trg-2/trg-2-4.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/release/trg-2/trg-2-4.md b/docs/release/trg-2/trg-2-4.md index 800c13586422..03ab09d67ab7 100644 --- a/docs/release/trg-2/trg-2-4.md +++ b/docs/release/trg-2/trg-2-4.md @@ -10,7 +10,7 @@ title: TRG 2.04 - Leading product repository ## Why -We have multiple stakeholders for a repository: system team, release management, test management, external people who are trying it out, want to contribute or need to set it up. +We have multiple stakeholders for a repository: system team, release management, test management, interested persons trying it out, want to contribute or need to set it up. They need to be able to understand complicated product structures in an intuitive way to have an easier task of diving into a product. ## Description @@ -21,8 +21,8 @@ This can be achieved by having a single repository for a product or creating ref Exemplary repository structure: - productname: leading product repository - - README.md: contains the urls for e.g. the backend and frontend applications - - README.md: each repo follows our [TRG 1.01](../trg-1/trg-1-1.md) about the README.md + - README.md: contains the URLs for e.g. the backend and frontend applications + - README.md: each repo has to follow our [TRG 1.01](../trg-1/trg-1-1.md) about the README.md - README.md: an [example section](#readme-example-section-for-a-leading-product-repository) for a leading product repository - contains the release of the product - contains the [product helm chart](../trg-5/trg-5-08) @@ -36,7 +36,7 @@ And each repo **must** contain the metafile see [TRG 2.05](../trg-2/trg-2-5.md). - The name of the leading product repository **must** contain the product name without prefix or suffix - It **should** contain the release (whether it is source code, helm chart or any other artifact) - README.md contains the description of what the product does -- README.md contains the references/urls to the product's other repositories if they exist +- README.md contains the references/URLs to the product's other repositories if they exist - It **should** contain the [TRG 5.08 - Product Helm Chart](https://eclipse-tractusx.github.io/docs/release/trg-5/trg-5-08) ### README example section for a leading product repository From 41af22db2d515e965ba4f7df98727ea62f70ed44 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabian=20Gr=C3=BCn?= Date: Mon, 8 Jan 2024 10:11:35 +0100 Subject: [PATCH 7/7] docs: reword the why with small letters for the teams Co-authored-by: Harald Zierer <101179191+hzierer@users.noreply.github.com> --- docs/release/trg-2/trg-2-4.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/release/trg-2/trg-2-4.md b/docs/release/trg-2/trg-2-4.md index 03ab09d67ab7..a07d3d21127c 100644 --- a/docs/release/trg-2/trg-2-4.md +++ b/docs/release/trg-2/trg-2-4.md @@ -10,7 +10,7 @@ title: TRG 2.04 - Leading product repository ## Why -We have multiple stakeholders for a repository: system team, release management, test management, interested persons trying it out, want to contribute or need to set it up. +We have multiple stakeholders for a repository: system team, test management, release management and everybody else interested in the product. They need to be able to understand complicated product structures in an intuitive way to have an easier task of diving into a product. ## Description