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

Diataxis restructure of NVD content and added more references to link security topics #30654

Merged
merged 1 commit into from
Jan 27, 2023

Conversation

michelle-purcell
Copy link
Contributor

@michelle-purcell michelle-purcell commented Jan 27, 2023

  1. Moved the detailed content in the US National Vulnerability Database registration section from the Security overview topic to a new diataxis concept topic called Security vulnerability detection and reporting in Quarkus.

  2. Connected the (somewhat isolated) Basic authentication concept to the other topics in this family*.

[*] - Observation: Enhancing the doc website UI by adding more navigation features that support Quarkus taxonomy could prevent the need to manually add and maintain lots of links & xrefs, like those added to this PR.

  1. Some style improvements.

@michelle-purcell michelle-purcell marked this pull request as draft January 27, 2023 11:22
@michelle-purcell michelle-purcell marked this pull request as ready for review January 27, 2023 11:51
@michelle-purcell
Copy link
Contributor Author

FYI: @inoxx03 , @MichalMaler , @sheilamjones , @rolfedh , @ebullient and @anyone-else-in-the-community - Review and feedback welcome. Thank you.

@github-actions
Copy link

github-actions bot commented Jan 27, 2023

🙈 The PR is closed and the preview is expired.

Use HTTPS with Basic Authentication to avoid exposing the credentials.
The risk of exposing credentials as plain text increases if a load balancer terminates HTTPS, as the request is forwarded to Quarkus over HTTP.
== Limitations with using Basic authentication

Copy link
Member

Choose a reason for hiding this comment

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

Should we have a rule about allowing uppercase B for basic when followed by authentication? common warning here.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'm on it... [we added one recently to the vale-at-red-hat repo, I will reuse that and other enhancements since the last rule update].

Fixed NVD ref

Fixed build errors
@ebullient ebullient merged commit 24bae58 into quarkusio:main Jan 27, 2023
@quarkus-bot quarkus-bot bot added this to the 2.17 - main milestone Jan 27, 2023
@sberyozkin
Copy link
Member

Nice work, thanks @michelle-purcell

@sberyozkin
Copy link
Member

Thanks for reviewing @ebullient

@michelle-purcell
Copy link
Contributor Author

@ebullient & @sberyozkin: Thanks 👍

@gsmet
Copy link
Member

gsmet commented Feb 28, 2023

Again let's be more conservative with the doc backports. We cannot backport large changes.

@michelle-purcell michelle-purcell deleted the doc-basic-auth branch May 8, 2023 08:09
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.

4 participants