Skip to content
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

docs: update product release issue template #813

Open
wants to merge 9 commits into
base: main
Choose a base branch
from

Conversation

ther3sa
Copy link

@ther3sa ther3sa commented Jul 19, 2024

Removed checks for interoperability, data sovereignty and threat modeling because of changes in the process

Pre-review checks

Please ensure to do as many of the following checks as possible, before asking for committer review:

Copy link
Contributor

@evegufy evegufy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good!

just one thing, it might make sense to wait for eclipse-tractusx/eclipse-tractusx.github.io#865 to be merged to remove also the Styleguide point, which is also moved to a TRG

And just one small hint: the pull request title is very long, would maybe make sense to summerize to into something like docs: update product release issue template

@ther3sa ther3sa changed the title docs: remove checks for interoperability, data sovereignty and threat modeling docs: update product release issue template Jul 23, 2024
Copy link
Contributor

@FaGru3n FaGru3n left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, looks a bit cleaner now

@matbmoser
Copy link

Shall we add the #Feature section?

Examples:

@ther3sa
Copy link
Author

ther3sa commented Jul 26, 2024

Looks good!

just one thing, it might make sense to wait for eclipse-tractusx/eclipse-tractusx.github.io#865 to be merged to remove also the Styleguide point, which is also moved to a TRG

And just one small hint: the pull request title is very long, would maybe make sense to summerize to into something like docs: update product release issue template

Hey Evelyn,
what do you mean by Styleguide point? :)

@matbmoser
Copy link

matbmoser commented Jul 26, 2024

@ther3sa there is a new TRG about styleguide: https://eclipse-tractusx.github.io/docs/release/trg-9/trg-9-01

Honestly, I would keep it out of the v24.08, and maybe ensure that is compliant in the v24.12.

@evegufy
Copy link
Contributor

evegufy commented Jul 29, 2024

Looks good!
just one thing, it might make sense to wait for eclipse-tractusx/eclipse-tractusx.github.io#865 to be merged to remove also the Styleguide point, which is also moved to a TRG
And just one small hint: the pull request title is very long, would maybe make sense to summerize to into something like docs: update product release issue template

Hey Evelyn, what do you mean by Styleguide point? :)

I think I was confusing it with the point User Journey, I suggest to either remove it or define who should check that in the future, as the role of the PO doesn't exist anymore

@evegufy evegufy mentioned this pull request Jul 29, 2024
3 tasks
@ther3sa ther3sa requested a review from evegufy August 8, 2024 11:22
@ther3sa ther3sa requested a review from matbmoser August 8, 2024 11:54
@evegufy
Copy link
Contributor

evegufy commented Aug 13, 2024

Looks good!
just one thing, it might make sense to wait for eclipse-tractusx/eclipse-tractusx.github.io#865 to be merged to remove also the Styleguide point, which is also moved to a TRG
And just one small hint: the pull request title is very long, would maybe make sense to summerize to into something like docs: update product release issue template

Hey Evelyn, what do you mean by Styleguide point? :)

I think I was confusing it with the point User Journey, I suggest to either remove it or define who should check that in the future, as the role of the PO doesn't exist anymore

@ther3sa could you please provide feedback about the removal of the User Journey or if it's not planned to remove it, who is supposed to check that?

@ther3sa
Copy link
Author

ther3sa commented Aug 26, 2024

Looks good!
just one thing, it might make sense to wait for eclipse-tractusx/eclipse-tractusx.github.io#865 to be merged to remove also the Styleguide point, which is also moved to a TRG
And just one small hint: the pull request title is very long, would maybe make sense to summerize to into something like docs: update product release issue template

Hey Evelyn, what do you mean by Styleguide point? :)

I think I was confusing it with the point User Journey, I suggest to either remove it or define who should check that in the future, as the role of the PO doesn't exist anymore

@ther3sa could you please provide feedback about the removal of the User Journey or if it's not planned to remove it, who is supposed to check that?

I am currently in the process of clarifying how we will deal with the user journey in future. I will provide an update on this as soon as I have a result. :)

@stephanbcbauer stephanbcbauer marked this pull request as draft August 27, 2024 08:23
@stephanbcbauer
Copy link
Member

stephanbcbauer commented Aug 27, 2024

@ds-hzimmer , @ds-tthies , @ther3sa as discussed ... @ther3sa and I adapted the content. Please have a look beforehand. Is something missing? If yes, please adapt.

We should check topics redundant. Some checks are already done via TRGs

@ther3sa ther3sa marked this pull request as ready for review September 19, 2024 12:58
| linked feature 2 | Test status | note 2 |
| linked feature 3 | Test status | note 3 |

## Documentation
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

point is redundant to TRG 1

- [ ] Integration tests are updated
- [ ] E2E/Integration test passed
- [ ] Regressions tests passed
- [ ] User Journey approved
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

moving the point with the md file didn't answer my question: #813 (comment)

## Deployment Readiness
<!-- Responsibility: Committer, Testmanagement, Releasemanagement -->

- [ ] Release notes/Change logs are updated
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- [ ] Release notes/Change logs are updated
- [ ] Release notes/Changelogs are updated

- [ ] Documentation (related to new implemented features e.g. migration, api) is updated to reflect changes
- [ ] README and other project documentation are clear and up-to-date

## Deployment Readiness
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the name - which is referring to deployment - doesn't make sense to me considering bellows

Suggested change
## Deployment Readiness
## Release Documentation

@matbmoser
Copy link

@stephanbcbauer and @ther3sa
Can we also add something like: Architecture Approval? Was not somthing that was mentioned in the last technical sync?

Do we also want to include dependencies? Like - Updated dependency graph?

<!-- For this new release -->
- Committer: *GitHub handle*
- ExpertGroup: *GitHub handle*
- Technical contact: *GitHub handle*

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this really necessary? Shall we not say Contributors?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants