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

Fix release notes links #843

Conversation

jmagak
Copy link
Contributor

@jmagak jmagak commented Jan 13, 2025

IMPORTANT: Do Not Merge - To be merged by Docs Team Only

Version(s): 1.4

Add the relevant labels to the Pull Request.
Issue: https://issues.redhat.com/browse/RHIDP-5458

@rhdh-bot
Copy link
Collaborator

rhdh-bot commented Jan 13, 2025

Copy link
Member

@linfraze linfraze left a comment

Choose a reason for hiding this comment

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

A couple comments, otherwise lgtm

modules/release-notes/ref-release-notes-new-features.adoc Outdated Show resolved Hide resolved
modules/release-notes/ref-release-notes-new-features.adoc Outdated Show resolved Hide resolved
modules/release-notes/ref-release-notes-new-features.adoc Outdated Show resolved Hide resolved
Copy link
Member

@linfraze linfraze left a comment

Choose a reason for hiding this comment

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

approving /lgtm

@nickboldt
Copy link
Member

approving /lgtm

release notes are generated using JIRA as the single source of truth. Please apply your changes in https://issues.redhat.com/browse/RHIDP-3621 then run this script:

https://github.com/redhat-developer/red-hat-developers-documentation-rhdh/blob/release-1.4/modules/release-notes/single-source-release-notes.py

If you apply these changes and then we release a 1.4.2 security / bug fix update, your changes will be overwritten by the above script.

So it's 100% better to use JIRA release note text fields for the contents of the release notes.

@nickboldt
Copy link
Member

Regenerated from JIRA release note text fields and pushed the changes into your PR.

If that reverted your requested changes, please apply them in JIRA and I can re-run the ./modules/release-notes/single-source-release-notes.py script for you.

Here's my changes (with whitespace / line ending changes ignored):

6bc66e9?w=1

@jmagak jmagak force-pushed the RHIDP-5458-Fix-Release-Notes-1.4-New-Features-Links branch from 6bc66e9 to 4a8f61e Compare January 23, 2025 13:15
@jmagak
Copy link
Contributor Author

jmagak commented Jan 23, 2025

Regenerated from JIRA release note text fields and pushed the changes into your PR.

If that reverted your requested changes, please apply them in JIRA and I can re-run the ./modules/release-notes/single-source-release-notes.py script for you.

Here's my changes (with whitespace / line ending changes ignored):

6bc66e9?w=1

Hi @nickboldt , I ran the script and this PR should be in sync with those from your end.

@jmagak
Copy link
Contributor Author

jmagak commented Jan 24, 2025

@rm3l @nickboldt @jmagak @Preeticp even more than a link to a page about what configuration profiles are, what I think would be most helpful for the user is to know what the additional profiles are, why they have been added, and how the user can benefit from the addition. Any reason why we aren't sharing that info?

That is a great suggestion, as well as wonderful questions you have raised, @linfraze . I trust that a summary of the content in the link, rather than linking the entire document, might suffice in this case. My question, however, is where to draw the line on what to highlight from the upstream document, especially if we want to avoid leaving the user searching for additional content from where they cannot access.

Copy link
Member

@nickboldt nickboldt left a comment

Choose a reason for hiding this comment

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

modules/release-notes/ref-release-notes-new-features.adoc Outdated Show resolved Hide resolved
@jmagak jmagak force-pushed the RHIDP-5458-Fix-Release-Notes-1.4-New-Features-Links branch from 7be7c2f to 5611a2e Compare January 27, 2025 12:25
Copy link
Member

@nickboldt nickboldt left a comment

Choose a reason for hiding this comment

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

I notice you removed https://issues.redhat.com//browse/RHIDP-3817 as it's now set as upstream only. 👍

@themr0c themr0c merged commit b7b65c7 into redhat-developer:release-1.4 Jan 27, 2025
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants