Enhancements to Security Getting Started docs #27009
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
sberyozkin
reviewed
Jul 28, 2022
sberyozkin
reviewed
Jul 28, 2022
sberyozkin
reviewed
Jul 28, 2022
|
@michelle-purcell I've looked at this PR, a lot of effort has been put into it which is very appreciated, a lot of improvements are here, I've left a few minor suggestions, overall, a nicely done PR, thanks |
quarkus-bot
bot
added
area/dependencies
michelle-purcell
force-pushed
the
QDOCS-33
branch
2 times, most recently
from
3590df8 to
adaed4f
Compare
michelle-purcell
force-pushed
the
QDOCS-33
branch
from
adaed4f to
f462a0d
Compare
michelle-purcell
force-pushed
the
QDOCS-33
branch
3 times, most recently
from
08e2f6d to
0cff17b
Compare
michelle-purcell
force-pushed
the
QDOCS-33
branch
from
f22089a to
f8a13bd
Compare
michelle-purcell
force-pushed
the
QDOCS-33
branch
2 times, most recently
from
b446d6d to
6e51cf0
Compare
ebullient
reviewed
Aug 11, 2022
michelle-purcell
force-pushed
the
QDOCS-33
branch
2 times, most recently
from
a9ca81d to
a145a08
Compare
sberyozkin
reviewed
Aug 15, 2022
sberyozkin
reviewed
Aug 15, 2022
|
@michelle-purcell It is nearly ready to go, I propose to make only 2 more minor updates, thanks |
ebullient
reviewed
Aug 15, 2022
|
|
||
| In this example, we build a very simple microservice which offers three endpoints: | ||
| If you complete all of the steps in this tutorial, you will build a microservice that provides the following endpoints: |
There was a problem hiding this comment.
Suggested change
| If you complete all of the steps in this tutorial, you will build a microservice that provides the following endpoints: | |
| You will build an application that provides the following endpoints: |
Or something like (though this feels needlessly wordy, too):
The steps in this tutorial will guide you through building an application that provides the following endpoints:
The adverbial introductory phrases are not my favorite to read; it feels like a variant of passive voice.
There was a problem hiding this comment.
I agree. Fixed with a bit of tweaking.
michelle-purcell
force-pushed
the
QDOCS-33
branch
from
a145a08 to
8a1d0c8
Compare
ebullient
reviewed
Aug 17, 2022
ebullient
reviewed
Aug 17, 2022
sberyozkin
reviewed
Aug 17, 2022
michelle-purcell
force-pushed
the
QDOCS-33
branch
4 times, most recently
from
9c5cb44 to
58d9b5f
Compare
|
@sberyozkin + @ebullient - Thanks so much for reviewing my changes and your comments. I have now fixed all comments as per suggestions with some tweaks. Please take a look. |
Fixed headings Update docs/src/main/asciidoc/security-getting-started.adoc Co-authored-by: sberyozkin <[email protected]> SME enhancements to security Getting started docs Change title to Basic authentication Fixed title , abstract, sequence, and Maven bit Fix language and tone in 88 as per @ebullient Fixed 149 Update docs/src/main/asciidoc/security-getting-started.adoc Co-authored-by: sberyozkin <[email protected]> Update docs/src/main/asciidoc/security-getting-started.adoc Co-authored-by: sberyozkin <[email protected]> Update docs/src/main/asciidoc/security-getting-started.adoc Co-authored-by: Erin Schnabel <[email protected]> Further edits to fix SME suggestions
michelle-purcell
force-pushed
the
QDOCS-33
branch
from
58d9b5f to
9cece61
Compare
|
|
||
| After you complete this tutorial, you will be ready to apply more advanced security mechanisms in Quarkus, for example, how to use the OpenID Connect (OIDC) authentication mechanism. |
There was a problem hiding this comment.
Or, what about...
This tutorial prepares you for implementing more advanced security mechanisms in Quarkus, for example, how to use the OpenID Connect (OIDC) authentication mechanism.
ebullient
approved these changes
Aug 19, 2022
sberyozkin
approved these changes
Aug 19, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Edits to enhance the Quarkus security content and to prepare for future restructuring by using the Diataxis framework.
Relating to QDOCS-33