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

Edit Dev Services and UI for OIDC #37566

Merged
merged 1 commit into from
Jan 5, 2024
Merged

Conversation

rolfedh
Copy link
Contributor

@rolfedh rolfedh commented Dec 6, 2023

Purpose: Edit the "Dev Services and Dev UI for OpenID Connect (OIDC)" guide.
References: QDOCS-555

@rolfedh
Copy link
Contributor Author

rolfedh commented Dec 6, 2023

@sberyozkin You're welcome to question or push back on any of the proposed changes.
I went a little farther this time, trying to interpret and fix some ambiguous items.
Let me provide some context about these changes so you can review them effectively.

  • I noticed backticks (" ` ") around some items that didn't need them.
    • We use backticks to format object names, file paths, commands, output, and entered values as monospaced text. For example:
    `quarkus.oidc.auth-server-url` is
    
    • We generally leave proper names, such as the names of features, unformatted. For example, "the Dev Services For Keycloak feature".
    • We use asterisks to bold UI elements that users click or interact with. For example:
    Click the *Keycloak provider* link.
    

I noticed that, in the text, the labels of some UI elements such as button labels in the text didn't match the labels in the images. I revised the text to match the the images. This might be wrong and we might need to update the images to match the text instead. For example:

  • the *OpenID Connect* card
  • Click the *Keycloak provider* link.
  • so choose the *With Access Token* option,
  • Choose the *With ID Token* option in such cases.

Copy link

github-actions bot commented Dec 6, 2023

🙈 The PR is closed and the preview is expired.

@rolfedh
Copy link
Contributor Author

rolfedh commented Dec 6, 2023

@sberyozkin Some other changes you might notice:

  • I transformed future tense ("will") to present tense. The future tense can create comprehension problems, especially for users with specific linguistic backgrounds and during localization.
  • I converted titles to use sentence case: Lower case except for proper names.
  • I replaced "may" with other words to reduce comprehension/localization problems.

I'll be happy to explain or simply reverse any changes (or types or changes) that you request.
Thank you for your thoughtful reviews!

@rolfedh rolfedh force-pushed the QDOCS-555 branch 5 times, most recently from ed133d8 to eeae52f Compare December 6, 2023 16:17
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.

Perfect cleanup, @rolfedh, thanks, a couple of minor suggestions is proposed

@rolfedh
Copy link
Contributor Author

rolfedh commented Dec 7, 2023

Thanks again, @sberyozkin. I've applied your suggestions. I believe this PR is ready for merge.
I also fixed a small typo in security-openid-connect-client-reference.adoc left over from a comment in another merged PR.

@quarkus-bot quarkus-bot bot added the area/docstyle issues related for manual docstyle review label Dec 7, 2023
@rolfedh rolfedh force-pushed the QDOCS-555 branch 2 times, most recently from 6552ae3 to 4b0f7e2 Compare December 7, 2023 16:46
@sheilamjones
Copy link
Contributor

@rolfedh: I completed peer review with some comments for your consideration - mainly some capitalization/terminology questions, for example "Dev Services for Keycloak" and also some queries on some text ambiguities.

@rolfedh rolfedh removed the request for review from MichalMaler December 7, 2023 19:45
@rolfedh
Copy link
Contributor Author

rolfedh commented Dec 13, 2023

@sheilamjones, @sberyozkin: I've applied Sheila's suggestions to the file. If you both approve, this PR should be ready to merge.

@rolfedh
Copy link
Contributor Author

rolfedh commented Jan 4, 2024

Hi @sberyozkin. I believe this is ready for merge.

@sberyozkin
Copy link
Member

Thanks @rolfedh

@sberyozkin sberyozkin merged commit e87a492 into quarkusio:main Jan 5, 2024
5 checks passed
@quarkus-bot quarkus-bot bot added this to the 3.7 - main milestone Jan 5, 2024
rolfedh added a commit to rolfedh/quarkus that referenced this pull request Jan 8, 2024
Edit Dev Services and UI for OIDC
rolfedh added a commit to rolfedh/quarkus that referenced this pull request Jan 8, 2024
Edit Dev Services and UI for OIDC
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
Development

Successfully merging this pull request may close these issues.

3 participants