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: Add downstream-relevant attributes to facilitate single sourcing #45962

Merged
merged 1 commit into from
Mar 14, 2025

Conversation

sheilamjones
Copy link
Contributor

@sheilamjones sheilamjones commented Jan 29, 2025

This PR aims to update the upstream _attributes.adoc file with the additional attributes needed to migrate the Red Hat Deploying to OpenShift Container Platform guide to the upstream Quarkus community and to facilitate the single-sourcing of the guide back downstream.

For more information, see QDOCS-1082

Copy link

quarkus-bot bot commented Jan 29, 2025

Thanks for your pull request!

Your pull request does not follow our editorial rules. Could you have a look?

  • title should preferably start with an uppercase character (if it makes sense!)

This message is automatically generated by a bot.

@quarkus-bot quarkus-bot bot added area/docstyle issues related for manual docstyle review area/documentation labels Jan 29, 2025
@sheilamjones sheilamjones self-assigned this Jan 29, 2025
@sheilamjones sheilamjones changed the title [DOCS]: Add downstream-relevant attributes to facilitate single sourcing DOCS: Add downstream-relevant attributes to facilitate single sourcing Jan 29, 2025
@sheilamjones
Copy link
Contributor Author

Hi @gsmet, @rolfedh, @iocanel,
To migrate the Deploy to OpenShift guide from downstream to upstream, I need to add additional attributes to the upstream _attributes.adoc file. This will help facilitate the migration of the content from downstream to upstream and to single source this content back downstream for RHBQ 3.20.
Kind regards,
Sheila

Copy link

github-actions bot commented Jan 29, 2025

🙈 The PR is closed and the preview is expired.

This comment has been minimized.

Copy link
Contributor

@rolfedh rolfedh left a comment

Choose a reason for hiding this comment

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

I agree with gsmet's suggestions. Otherwise, everything looks good to me.

Copy link
Contributor

@iocanel iocanel left a comment

Choose a reason for hiding this comment

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

I agree with the changes requested by @gsmet

@sheilamjones sheilamjones force-pushed the QDOCS-1082-attributes branch from 0c06f41 to f411b57 Compare February 4, 2025 14:26
Copy link
Contributor Author

@sheilamjones sheilamjones left a comment

Choose a reason for hiding this comment

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

Thank you @iocanel. I have now implemented these fixes.

@sheilamjones sheilamjones requested a review from iocanel February 4, 2025 14:30
@sheilamjones
Copy link
Contributor Author

Hi @gsmet, @iocanel, @rolfedh,
Fix is implemented per your feedback. If all looks okay now, this PR is ready to merge.
Kind regards,
Sheila

This comment has been minimized.

Copy link
Contributor

@iocanel iocanel left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Contributor

@rolfedh rolfedh left a comment

Choose a reason for hiding this comment

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

LGTM

@sheilamjones sheilamjones force-pushed the QDOCS-1082-attributes branch from f411b57 to 609a6e6 Compare February 7, 2025 15:47

This comment has been minimized.

@sheilamjones sheilamjones requested a review from gsmet February 7, 2025 16:33
@sheilamjones
Copy link
Contributor Author

Hi @gsmet, @iocanel, @rolfedh,
Thanks all for your reviews and approval. This PR is ready to merge.
Kind regards,
Sheila

@iocanel
Copy link
Contributor

iocanel commented Feb 13, 2025

@gsmet: it seems that your change requests have been applied, can we merge this?

Comment on lines 76 to 79
:name-image-ubi8-open-jdk-17: registry.access.redhat.com/ubi8/openjdk-17
:name-image-ubi8-open-jdk-17-short: ubi8/openjdk-17
:name-image-ubi8-open-jdk-21: registry.access.redhat.com/ubi8/openjdk-21
:name-image-ubi8-open-jdk-21-short: ubi8/openjdk-21
Copy link
Member

Choose a reason for hiding this comment

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

Since this patch was written, we moved to Ubi 9 so this needs adjusment (included in future 3.20).

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Hi @gsmet, I updated these values to Ubi 9 per your suggestion. Can I clarify though that this will be correct for RHBQ 3.20 (which is based on upstream 3.19)? This PR is aimed to be backported to 3.19.
Regards,
Sheila

@sheilamjones sheilamjones force-pushed the QDOCS-1082-attributes branch from 609a6e6 to be67484 Compare March 11, 2025 13:03

This comment has been minimized.

@gsmet gsmet force-pushed the QDOCS-1082-attributes branch from be67484 to 8e10ae3 Compare March 13, 2025 18:15
Copy link
Member

@gsmet gsmet left a comment

Choose a reason for hiding this comment

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

I confirm UBI 9 is the version in 3.20.

Comment on lines +71 to +73
:jdk-version-other: 17
:jdk-version-latest: 21
:jdk-version-all: 17 or 21
Copy link
Member

Choose a reason for hiding this comment

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

Let's merge this to make progress but... I don't think this will fly but it's just an intuition as I have no idea how you plan to use them.

In the community, people can use any Java 17+ (typically, if they want to use Java 23, that's fine).

So please send me an email when you start using these, with a pointer, so that I can have a look.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Hi @gsmet,

Thanks for your review. These attributes are used mainly in the Prerequisites section of the various procedures (in the other PRs that you are reviewing/merging as part of this effort) for deploying to OpenShift.

For example, in the Prerequisite, "You have OpenJDK {jdk-version-other} or later installed."

Per your request, I will update you via email with more details. Again, many thanks for your reviews and feedback.

@gsmet gsmet added triage/backport-3.20 triage/waiting-for-ci Ready to merge when CI successfully finishes labels Mar 13, 2025
Copy link

quarkus-bot bot commented Mar 13, 2025

Status for workflow Quarkus Documentation CI

This is the status report for running Quarkus Documentation CI on commit 8e10ae3.

✅ The latest workflow run for the pull request has completed successfully.

It should be safe to merge provided you have a look at the other checks in the summary.

@gsmet gsmet merged commit 9832143 into quarkusio:main Mar 14, 2025
5 checks passed
@quarkus-bot quarkus-bot bot removed the triage/waiting-for-ci Ready to merge when CI successfully finishes label Mar 14, 2025
@quarkus-bot quarkus-bot bot added this to the 3.22 - main milestone Mar 14, 2025
@gsmet gsmet modified the milestones: 3.22 - main, 3.21.0 Mar 18, 2025
@gsmet gsmet modified the milestones: 3.21.0, 3.19.4 Mar 18, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docstyle issues related for manual docstyle review area/documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants