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

Recompose the security overview and built-in authentication content to diataxis doc templates #30422

Merged

sberyozkin merged 1 commit into quarkusio:main from michelle-purcell:QDOCS-86-recompose-security-overview-page

Jan 24, 2023

Contributor

michelle-purcell commented Jan 17, 2023 •

edited

Loading

Recompose the existing QUARKUS SECURITY OVERVIEW [security-overview-concept.adoc] and BUILT-IN AUTHENTICATION SUPPORT [security-built-in-authentication-support-concept.adoc] guides into the diataxis framework .

The net...

Moved the == Security architecture section into a new file on its own called security-architecture-concept.adoc.
Moved all sections relating to authentication mechanisms into a new file called security-authentication-mechanisms.adoc.
Moved == Identity providers into a new file called security-identity-providers.adoc.
Moved most of Built-in authentication support content into 2 new files:
- security-proactive-authentication-concept.adoc
- security-authentication-mechanisms.adoc.
Restructured the Security overview content and links.
Fixed existing links to the content that was moved.

Note: Identified style and grammar enhancements that also need to be fixed. For now, this PR focuses on moving and restructuring as a priority. Will address the other content style issues in another iteration.

Ref: QDOCS-86 & (some of) QDOCS-88

quarkus-bot bot added the area/documentation label

michelle-purcell commented

View reviewed changes

docs/src/main/asciidoc/security-overview-concept.adoc Show resolved Hide resolved

michelle-purcell commented

View reviewed changes

docs/src/main/asciidoc/security-overview-concept.adoc

-              In other contexts, it is possible to have other parallel representations of the same information or parts of it, for example, `SecurityContext`
-              for JAX-RS or `JsonWebToken` for JSON Web Tokens (JWT).
-              == Authentication mechanisms

Contributor Author

michelle-purcell Jan 18, 2023

Note: All of this H2 section in security-overview-concept.adoc is now moved into a new concept doc file in this PR named security-authentication-mechanisms-concept.adoc.

michelle-purcell commented

View reviewed changes

docs/src/main/asciidoc/security-overview-concept.adoc

-              |No
-              |===
-              [[identity-providers]]

Contributor Author

michelle-purcell Jan 18, 2023

Note: All of this H2 section of security-overview-concept.adoc is now moved as-is into a new concept topic in this PR named security-identity-providers-concept.adoc.

michelle-purcell commented

View reviewed changes

docs/src/main/asciidoc/security-overview-concept.adoc

               * `HttpAuthenticationMechanism`
               * `IdentityProvider`
               * `SecurityidentityAugmentor`
               For more information about customizing Quarkus Security including reactive security, and how to register a security provider, see xref:security-customization.adoc[Security customization].
-              == Combining authentication mechanisms

Contributor Author

michelle-purcell Jan 18, 2023

Note: All of this H2 section of security-overview-concept.adoc is now moved (as-is) to the end of a new concept topic in this PR named security-authentication-mechanisms-concept.adoc.

michelle-purcell force-pushed the QDOCS-86-recompose-security-overview-page branch 2 times, most recently from 4d0e509 to 521b869 Compare

January 18, 2023 22:48

michelle-purcell commented

View reviewed changes

docs/src/main/asciidoc/security-overview-concept.adoc

               `<suppress until="2022-01-01Z">...</suppress>`
               You can adjust the expiry date if you need to.
-              == Quarkus Security testing

Contributor Author

michelle-purcell Jan 18, 2023

This H2 section is moved further up within this overview topic. (Eventually this could evolve into a bigger how-to / tutorial.)

Member

sberyozkin Jan 19, 2023

FYI, we already have a security-testing.adoc, this section is only meant to link to it

sberyozkin reviewed

View reviewed changes

docs/src/main/asciidoc/security-architecture-concept.adoc Outdated Show resolved Hide resolved

michelle-purcell force-pushed the QDOCS-86-recompose-security-overview-page branch 2 times, most recently from 00b967e to 5243d00 Compare

January 20, 2023 16:38

quarkus-bot bot added area/devtools area/oidc labels

michelle-purcell force-pushed the QDOCS-86-recompose-security-overview-page branch 3 times, most recently from 29a7f46 to c45c2df Compare

January 20, 2023 16:56

michelle-purcell changed the title ~~WIP Qdocs 86 recompose security overview page~~ Recompose the security overview and built-in authentication content to diataxis doc templates

michelle-purcell force-pushed the QDOCS-86-recompose-security-overview-page branch 2 times, most recently from 16da0f5 to 04a223c Compare

January 20, 2023 17:30

Contributor Author

michelle-purcell commented Jan 20, 2023

@sberyozkin - I have now pushed more commits to resolve the comments so far and complete the link updates that were required. This PR is now ready for final review. Thanks.

Contributor Author

michelle-purcell commented Jan 20, 2023

@rolfedh , @inoxx03 , @sheilamjones , @MichalMaler, @ebullient, @any-other-community-sme-interested:
FYI - This content restructuring PR is now ready for review.
(The focus here is on restructuring into diataxis. Additional styling and new content will be needed here but in the next iteration of changes.)

michelle-purcell force-pushed the QDOCS-86-recompose-security-overview-page branch 2 times, most recently from cd1451c to 054a2e3 Compare

January 20, 2023 17:45

This comment has been minimized.

Sign in to view

michelle-purcell force-pushed the QDOCS-86-recompose-security-overview-page branch from 054a2e3 to 32ed6fd Compare

January 20, 2023 18:27

quarkus-bot bot added area/cli area/core labels

michelle-purcell force-pushed the QDOCS-86-recompose-security-overview-page branch from 32ed6fd to e858886 Compare

January 20, 2023 18:32

This comment has been minimized.

Sign in to view

Contributor Author

michelle-purcell commented Jan 23, 2023

@MichalMaler - Thanks so much for your review and great suggestions. I have fixed all suggestions and marked some lines for further style improvements.

Contributor Author

michelle-purcell commented Jan 23, 2023

@sberyozkin - Thank you for your thorough review and feedback 💯 . I have fixed all open comments. There's just one open comment from @mmaler that I fixed above that might need your SME input.

rolfedh approved these changes

View reviewed changes

Contributor

rolfedh left a comment

LGTM

Member

sberyozkin commented Jan 23, 2023

Hi @michelle-purcell thanks, I only did a few comments, thanks again for preparing this PR, the open but fixed comment looks fine. There is some doc bulid issue, please fix tomorrow and we will merge, thanks

sberyozkin self-requested a review

January 23, 2023 22:44

sberyozkin approved these changes

View reviewed changes

Member

sberyozkin commented Jan 23, 2023

Will be ready to go once the build failure is fixed

michelle-purcell force-pushed the QDOCS-86-recompose-security-overview-page branch from 02aae57 to e32f39a Compare

January 24, 2023 10:21

Contributor Author

michelle-purcell commented Jan 24, 2023

@sberyozkin - All conflicts are now resolved. I think we are ready to merge. Thanks 👍

michelle-purcell force-pushed the QDOCS-86-recompose-security-overview-page branch from e32f39a to 709fb54 Compare

January 24, 2023 10:53

quarkus-bot bot added area/panache area/scheduler labels

This comment has been minimized.

Sign in to view

michelle-purcell force-pushed the QDOCS-86-recompose-security-overview-page branch 2 times, most recently from 1174e5f to bbc05e0 Compare

January 24, 2023 11:46

Member

sberyozkin commented Jan 24, 2023

Hi @michelle-purcell you might've used the wrong sha to rebase against, 3c1d04c is now in the list of commits.
@gsmet Hi Guillaume, can you please advise how to fix it ?

michelle-purcell force-pushed the QDOCS-86-recompose-security-overview-page branch from bbc05e0 to a359f7a Compare

January 24, 2023 11:52

Member

sberyozkin commented Jan 24, 2023

Cool, thanks for fixing it so fast :-)


          Recompose security overview and built-in auth content to diataxis tem…

fb1da0f

…plates

Recomposing security overview content to diataxis

Recomposing security overview content to diataxis

Addressed Sergey's review comments

Further enhancements

fix typos grammar

Fixed broken links after recomposing to diataxis

Fixed headings

More link fixes

Fix mTLS case

Update docs/src/main/asciidoc/security-architecture-concept.adoc

Co-authored-by: Mickey Maler <mmaler@redhat.com>

Update docs/src/main/asciidoc/security-architecture-concept.adoc

Co-authored-by: Mickey Maler <mmaler@redhat.com>

Update docs/src/main/asciidoc/security-identity-providers-concept.adoc

Co-authored-by: Mickey Maler <mmaler@redhat.com>

Update docs/src/main/asciidoc/security-architecture-concept.adoc

Co-authored-by: Mickey Maler <mmaler@redhat.com>

Update docs/src/main/asciidoc/security-identity-providers-concept.adoc

Co-authored-by: Mickey Maler <mmaler@redhat.com>

Update docs/src/main/asciidoc/security-proactive-authentication-concept.adoc

Co-authored-by: Mickey Maler <mmaler@redhat.com>

Update docs/src/main/asciidoc/security-proactive-authentication-concept.adoc

Co-authored-by: Mickey Maler <mmaler@redhat.com>

Update docs/src/main/asciidoc/security-proactive-authentication-concept.adoc

Co-authored-by: Mickey Maler <mmaler@redhat.com>

Update docs/src/main/asciidoc/security-proactive-authentication-concept.adoc

Co-authored-by: Mickey Maler <mmaler@redhat.com>

Update docs/src/main/asciidoc/security-proactive-authentication-concept.adoc

Co-authored-by: Mickey Maler <mmaler@redhat.com>

Some style enhancements

Update docs/src/main/asciidoc/security-proactive-authentication-concept.adoc

Co-authored-by: Mickey Maler <mmaler@redhat.com>

Style enhancement: reduce wordiness

tweak

Fixed further comments

asciidocfix and added link

Fixed some typos

Fixed build error

2023-01-24T11:15:40.1095928Z [ERROR] asciidoctor: WARN: security-proactive-authentication-concept.adoc: line 86: section title out of sequence: expected level 1, got level 2

michelle-purcell force-pushed the QDOCS-86-recompose-security-overview-page branch from a359f7a to fb1da0f Compare

January 24, 2023 12:17

quarkus-bot bot commented Jan 24, 2023

✔️ 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.

Contributor Author

michelle-purcell commented Jan 24, 2023

@sberyozkin & @gsmet - by the time I fixed my asciidoc source doc build issue, my branch was out of date! I've since rebased and all looks good now. Can we merge now? Thank you!

sberyozkin merged commit 3affaf2 into quarkusio:main

quarkus-bot bot added this to the 2.17 - main milestone

michelle-purcell added the triage/backport? label

Contributor Author

michelle-purcell commented Feb 27, 2023

@sberyozkin - FYI, added the 2.16 backport label to this merged security docs PR also.

gsmet removed the triage/backport? label

Member

gsmet commented Feb 28, 2023

I won't backport this one because of too many conflicts.

I think we need to be a lot more conservative about what we backport for documentation. Typos and small changes are OK but definitely not large structural changes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/arc area/cli area/core area/devtools area/documentation area/oidc area/panache area/reactive-sql-clients area/scheduler area/testing