Skip to content

Commit a9313b1

Browse files
Merge pull request #1187 from gerbigf/docs-trg-migration-guide
docs: [TRG] Initial Proposal for a documentation TRG "Migration Guide" (1.09)
2 parents a525b35 + 4fbb36e commit a9313b1

File tree

2 files changed

+39
-1
lines changed

2 files changed

+39
-1
lines changed

DEPENDENCIES

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1361,4 +1361,4 @@ npm/npmjs/@webassemblyjs/wasm-opt/1.14.1, MIT, approved, clearlydefined
13611361
npm/npmjs/@webassemblyjs/wasm-parser/1.14.1, MIT, approved, clearlydefined
13621362
npm/npmjs/@webassemblyjs/wast-printer/1.14.1, MIT, approved, clearlydefined
13631363
npm/npmjs/@xtuc/ieee754/1.2.0, BSD-3-Clause, approved, #123
1364-
npm/npmjs/@xtuc/long/4.2.2, Apache-2.0, approved, clearlydefined
1364+
npm/npmjs/@xtuc/long/4.2.2, Apache-2.0, approved, clearlydefined

docs/release/trg-1/trg-1-09.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
title: TRG 1.09 - Migration Guide
3+
sidebar_position: 1
4+
---
5+
6+
:::caution
7+
Proposed release date: "mandatory after": tbd
8+
:::
9+
10+
| Status | Created | Post-History |
11+
|------------|--------------|----------------------------------------|
12+
| Draft | 12-March-2025 | Initial contribution |
13+
| Active | 23-May-2025 | Committer Meeting Review |
14+
15+
## Why
16+
17+
IT operations managers and end-users of a component need a way to understand the impact of a new release on their work. This could be a required database migration, a change in an API call or system behavior.
18+
19+
Those changes aren't obvious just based on a changelog ([TRG 1.03](https://eclipse-tractusx.github.io/docs/release/trg-1/trg-1-3)) that usually only list all PRs within a release.
20+
21+
## Description
22+
23+
A migration guide **must** contain all relevant information for IT operation managers of a component to migrate an existing component from the previous to the new version. It must be placed in a directory named `/docs/admin`.
24+
25+
It **must** also contain all relevant changes for end-users, such as changed API calls, component behaviour, added/deprecated customer facing features etc.
26+
27+
The migration guide shall _explain_ relevant changes to operators and users and not simply list them.
28+
29+
## Best Practices
30+
31+
- A migration guide should support IT operations management and guide the efforts for updating dependent tools and processes.
32+
- There should be a dedicated migration guide per release that contains relevant changes for IT operations managers or end users : E.g. From 1.1.x -> 1.2.x, 1.2.x -> 2.0.x etc.
33+
- A migration guide should only explain those changes that require an action by IT operations managers or end-users of a component. It should not be a duplication of the changelog.
34+
35+
## Examples
36+
37+
- [EDC migration guide](https://github.com/eclipse-tractusx/tractusx-edc/tree/main/docs/migration)
38+
- [Portal migration guide](https://github.com/eclipse-tractusx/portal-assets/blob/v2.3.0/docs/admin/Version%20Upgrade/portal-upgrade-details.md)

0 commit comments

Comments
 (0)