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.

Sign up for GitHub

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

Jump to bottom

Fix content issues in security guides #41712

Merged
merged 1 commit into from
Jul 11, 2024
Merged

Fix content issues in security guides #41712

merged 1 commit into from
Jul 11, 2024

Conversation

rolfedh
Copy link
Contributor

@rolfedh rolfedh commented Jul 5, 2024 •
edited
Loading

This PR incorporates QE feedback from the review of the product security guides into the community files. The changes include:

  • Adding additional conditionalization to specific sections.
  • Making minor content tweaks and fixing typos.
  • Preventing duplicate ID errors that cause build failures.
@quarkus-bot quarkus-bot bot added area/docstyle issues related for manual docstyle review area/documentation labels Jul 5, 2024
@quarkus-bot quarkus-bot bot added this to To do in Quarkus Documentation Jul 5, 2024
@rolfedh rolfedh marked this pull request as draft July 5, 2024 13:08
@rolfedh rolfedh changed the title Up-port QE tweaks to main Jul 5, 2024
@quarkus-bot

This comment has been minimized.

Sign in to view
@rolfedh rolfedh requested a review from michalvavrik July 8, 2024 21:04
@rolfedh rolfedh force-pushed the up-port-qe-fixes branch 2 times, most recently from 5972113 to 8278214 Compare July 9, 2024 15:13
@quarkus-bot

This comment has been minimized.

Sign in to view
@sberyozkin
Copy link
Member

@rolfedh LGTM too, thanks, should be ready to go once the build issue is fixed; also makes sense to refer to the 25.0.0 as the minimum KC version as noticed by Michal.
Thanks
@rolfedh rolfedh marked this pull request as ready for review July 9, 2024 16:56
This was referenced Jul 9, 2024
Merged
Merged
@quarkus-bot

This comment has been minimized.

Sign in to view
@rolfedh rolfedh force-pushed the up-port-qe-fixes branch 2 times, most recently from 56ed539 to a53c87a Compare July 9, 2024 17:27
@quarkus-bot

This comment has been minimized.

Sign in to view
@rolfedh rolfedh requested a review from sberyozkin July 9, 2024 18:05
sberyozkin
sberyozkin approved these changes Jul 9, 2024
View reviewed changes
Copy link
Member

@sberyozkin sberyozkin left a comment

Choose a reason for hiding this comment

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

LGTM, thanks @rolfedh and @michalvavrik. I'd like to CC @maxandersen and @gsmet just in case before merging it, for them be aware of the proposed convention to use document name specific prefixes/qualifiers for the document local sections, in order to avoid conflicts in a large single RHBQ doc
Quarkus Documentation automation moved this from To do to Reviewer approved Jul 9, 2024
@rolfedh
Copy link
Contributor Author

rolfedh commented Jul 9, 2024

LGTM, thanks @rolfedh and @michalvavrik. I'd like to CC @maxandersen and @gsmet just in case before merging it, for them be aware of the proposed convention to use document name specific prefixes/qualifiers for the document local sections, in order to avoid conflicts in a large single RHBQ doc

Hi @sberyozkin. Thanks for suggesting this.
Explanation: When multiple community guides are integrated into a single product guide, their IDs occupy the same namespace. If those IDs are the same, the docs build toolchain fails the build. The simplest way to address this issue is to modify only the IDs that produced errors so they are unique, as was done in this PR.
Quarkus Documentation automation moved this from Reviewer approved to Review pending Jul 10, 2024
@quarkus-bot

This comment has been minimized.

Sign in to view
@rolfedh rolfedh requested a review from gsmet July 10, 2024 12:39
@quarkus-bot
Copy link

quarkus-bot bot commented Jul 10, 2024

Status for workflow Quarkus Documentation CI

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

✅ 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 dismissed their stale review July 11, 2024 10:56

The change I wanted dropped has been dropped.

Quarkus Documentation automation moved this from Review pending to Reviewer approved Jul 11, 2024
@gsmet gsmet merged commit dbced0b into quarkusio:main Jul 11, 2024
5 checks passed
Quarkus Documentation automation moved this from Reviewer approved to Done Jul 11, 2024
@quarkus-bot quarkus-bot bot added this to the 3.13 - main milestone Jul 11, 2024
@github-actions GitHub Actions
Copy link

🙈 The PR is closed and the preview is expired.
@rolfedh rolfedh mentioned this pull request Jul 11, 2024
Merged
@rolfedh
Copy link
Contributor Author

rolfedh commented Jul 11, 2024 •
edited
Loading

Prequalified the synchronization job by using the "Try ingesting from an upstream pull request" pipeline schedule to create https://gitlab.cee.redhat.com/quarkus-documentation/quarkus/-/jobs/23659885 .
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
4 participants
@rolfedh @sberyozkin @gsmet @michalvavrik