Skip to content

Commit e9ee477

Browse files
committed
docs: rephrasing repo example declaration
1 parent c9fcd13 commit e9ee477

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

docs/release/trg-2/trg-2-4.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -10,24 +10,24 @@ title: TRG 2.04 - Leading product repository
1010

1111
## Why
1212

13-
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.
13+
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.
1414
They need to be able to understand complicated product structures in an intuitive way to have an easier task of diving into a product.
1515

1616
## Description
1717

1818
Each product **must** have a leading product repository that can point the users to all the parts/components/charts/releases of that product.
1919
This can be achieved by having a single repository for a product or creating references to the other repositories.
2020

21-
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:
21+
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:
2222

2323
- productname: leading product repository
24-
- README.md: contains the urls for the backend and frontend applications
24+
- README.md: contains the urls for e.g. the backend and frontend applications
2525
- README.md: each repo follows our [TRG 1.01](../trg-1/trg-1-1.md) about the README.md
26-
- README.md: an [example](#readme-example-section-for-a-leading-product-repository) for a leading product repository
26+
- README.md: an [example section](#readme-example-section-for-a-leading-product-repository) for a leading product repository
2727
- contains the release of the product
2828
- contains the [product helm chart](../trg-5/trg-5-08)
29-
- productname-A-frontend: the repository for the frontend application
30-
- productname-A-backend: the repository for the backend application
29+
- productname-a-component: e.g. the repository for the frontend application
30+
- productname-b-component: e.g. the repository for the backend application
3131

3232
## Leading product repository rules
3333

0 commit comments

Comments
 (0)