-
Notifications
You must be signed in to change notification settings - Fork 95
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Initial proposal for TRG 1.09 #1187
base: main
Are you sure you want to change the base?
Conversation
|
||
## Best Practices | ||
|
||
- A migration guide should be understandable by both operators and users of a component. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would try to rephrase the text to talk about operations and usage instead of operators and users. Reasoning behind this is, that especially user is misleading. A user in this sense is in many cases a developer of a tooling that makes use of an api. Referring to the situation as usage could make reading the guide easier to digest.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
IT Operations Management
is well established ITIL lingo and should be easily understood by the audience of this TRG.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@ClosedSourcerer @lgblaumeiser so you would propose something like "A migration guide should support IT operations management and enable usage of a new release"?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It is not that easy, I have to admit
- A migration guide should be understandable by both operators and users of a component. | |
- A migration guide should support IT operations management and guide the efforts for updating dependent tools and processes. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Personally I am always shook by the overall inconsistency of the structure of the TRGs.
They are all way to unique.
|
||
The migration guide shall _explain_ relevant changes to operators and users. | ||
|
||
## Best Practices |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I really hate the fact, that TRGs are currently not very consistent in their structure.
20 TRGs use Example
5 TRGs Use Best Practice
1 TRG uses Best Practices and Example
I suggest switching to Example
and also including an example and scrapping Best Practice
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@ClosedSourcerer Examples and Best Practices are two different things for me. I chose not to provide an example, because this always depends on the application... We could however link to "good examples" that already do that, such as the portal or the EDC. I'd still like to keep the best practices... would you suggest to add them to the "description"?
|
||
## Best Practices | ||
|
||
- A migration guide should be understandable by both operators and users of a component. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
IT Operations Management
is well established ITIL lingo and should be easily understood by the audience of this TRG.
## Best Practices | ||
|
||
- A migration guide should be understandable by both operators and users of a component. | ||
- There should be a dedicated migration guide per release: E.g. From 1.1.x -> 1.2.x, 1.2.x -> 2.0.x etc. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We could narrow the need for a migration guide to major releases only, which is the case where breaking changes can occur.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@rafaelmag110 we aren't really following semantic versioning in all products - EDC and DTR contain "breaking breaking changes" although we just increase the minor counter. So a proposal could be "There must be a dedicated migration guide for each major release. For minor releases a guide must only be provided if it affects the usage or operation of a service.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for proposing. The others already had valid points. I would just add a directory where to put it.
sounds good! Co-authored-by: Tom Meyer <[email protected]>
Co-authored-by: Lars Geyer-Blaumeiser <[email protected]>
There's a TRG-0-template that might be missing a couple of things then ;) |
Description
This PR provides a draft proposal for a new TRG 1.09 - Release Guide.
Closes #1185 and #1163
Pre-review checks
Please ensure to do as many of the following checks as possible, before asking for committer review: