Skip to content

Commit c9fcd13

Browse files
committed
docs: add trg 2-4 leading readme example
1 parent 7f6c418 commit c9fcd13

File tree

1 file changed

+15
-4
lines changed

1 file changed

+15
-4
lines changed

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

+15-4
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,11 @@
22
title: TRG 2.04 - Leading product repository
33
---
44

5-
| Status | Created | Post-History |
6-
|--------|-------------|-----------------|
7-
| Active | 07-Mar-2023 | |
8-
| | 10-Jan-2023 | Initial release |
5+
| Status | Created | Post-History |
6+
|--------|-------------|------------------------------------------------|
7+
| Update | 12-Dez-2023 | add example leading repository reference links |
8+
| Active | 07-Mar-2023 | |
9+
| | 10-Jan-2023 | Initial release |
910

1011
## Why
1112

@@ -21,6 +22,8 @@ A good example when a product has a separate repository for frontend and backend
2122

2223
- productname: leading product repository
2324
- README.md: contains the urls for the backend and frontend applications
25+
- 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
2427
- contains the release of the product
2528
- contains the [product helm chart](../trg-5/trg-5-08)
2629
- 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
3336
- README.md contains the description of what the product does
3437
- README.md contains the references/urls to the product's other repositories if they exist
3538
- It **should** contain the [TRG 5.08 - Product Helm Chart](https://eclipse-tractusx.github.io/docs/release/trg-5/trg-5-08)
39+
40+
### README example section for a leading product repository
41+
42+
```markdown
43+
Leading repository for [product-name](link_to_product_repository):
44+
- [product component A](link_to_product_component_A_repository)
45+
- [product component B](link_to_product_component_B_repository)
46+
```

0 commit comments

Comments
 (0)