Skip to content

Commit

Permalink
docs: rephrasing repo example declaration
Browse files Browse the repository at this point in the history
  • Loading branch information
FaGru3n committed Dec 13, 2023
1 parent c9fcd13 commit e9ee477
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions docs/release/trg-2/trg-2-4.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,24 +10,24 @@ 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

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

Expand Down

0 comments on commit e9ee477

Please sign in to comment.