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

Improve security-getting-started-tutorial doc #37694

Merged
merged 1 commit into from
Jan 4, 2024
Merged

Improve security-getting-started-tutorial doc #37694

merged 1 commit into from
Jan 4, 2024

Conversation

sberyozkin
Copy link
Member

@sberyozkin sberyozkin commented Dec 12, 2023 •
edited
Loading

Fixes #37499

CC @gtroitsk

Points 1-3 remain unresolved, so keeping it as Draft for now

@sberyozkin sberyozkin requested a review from rsvoboda December 12, 2023 18:24
@quarkus-bot quarkus-bot bot added area/docstyle issues related for manual docstyle review area/documentation labels Dec 12, 2023
@github-actions GitHub Actions
Copy link

github-actions bot commented Dec 12, 2023 •
edited
Loading

🙈 The PR is closed and the preview is expired.

@sberyozkin sberyozkin force-pushed the improve_security_getting_started_tutorial branch 2 times, most recently from 92ec5a6 to 19e8d09 Compare January 2, 2024 17:37
@sberyozkin sberyozkin marked this pull request as ready for review January 2, 2024 17:37
@sberyozkin
Copy link
Member Author

@gtroitsk @rsvoboda I believe points 1-3 are now resolved, specifically, as far as the point 1 is concerned I removed a ref to the ProductName template var - looks like it was added here to make it available downstream - but no other guides do it

@gtroitsk
Copy link

gtroitsk commented Jan 3, 2024

@sberyozkin I have only one note. In preview I see that section "Define the user entity" is displayed as title. There may be an extra level 3 section heading (===). It is displayed as === Define the user entity

@sberyozkin sberyozkin force-pushed the improve_security_getting_started_tutorial branch from 19e8d09 to b0b68fb Compare January 4, 2024 18:37
@sberyozkin
Copy link
Member Author

sberyozkin commented Jan 4, 2024 •
edited
Loading

@gtroitsk Thanks for the quality review, I've fixed it by having both Define User Entity and Configure Application set with a == title property, === is not quite correct and it is also, as you have spotted, is not rendered correctly, though I'm not sure why, there are some docstyle characters around...
I had to rebase and resolve the conflict - as the Doc team is working on these docs too, please check the preview

CC @rsvoboda

@gtroitsk
Copy link

gtroitsk commented Jan 4, 2024

@sberyozkin Thank you, preview looks good

@rsvoboda rsvoboda merged commit 07637c7 into quarkusio:main Jan 4, 2024
5 checks passed
@quarkus-bot quarkus-bot bot added this to the 3.7 - main milestone Jan 4, 2024
@sberyozkin sberyozkin deleted the improve_security_getting_started_tutorial branch January 4, 2024 21:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@rsvoboda rsvoboda rsvoboda approved these changes

Assignees
No one assigned
Labels
area/docstyle issues related for manual docstyle review area/documentation kind/bugfix
Projects
Quarkus Documentation
Status: Done
Milestone
3.7.0.CR1
Development

Successfully merging this pull request may close these issues.

Docs: security-getting-started-tutorial guide
3 participants
@sberyozkin @gtroitsk @rsvoboda