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

Doc style and link enhancements #35897

Conversation

michelle-purcell
Copy link
Contributor

@michelle-purcell michelle-purcell commented Sep 12, 2023

This PR fixes style issues (title capitalization, one sentence per line...), links, and some grammar as per the preferred Quarkus Contributor guidelines for writing tutorials.
This also harmonizes the content with product docs downstream for the 3.2 release.

@quarkus-bot quarkus-bot bot added area/docstyle issues related for manual docstyle review area/documentation labels Sep 12, 2023
@michelle-purcell michelle-purcell force-pushed the security-doc-fixes-3-2-bearer-concept branch 3 times, most recently from 58b1b9f to 1a02aef Compare September 21, 2023 22:21
@michelle-purcell michelle-purcell force-pushed the security-doc-fixes-3-2-bearer-concept branch from 1a02aef to 4c9ff7a Compare September 21, 2023 22:23
@michelle-purcell michelle-purcell changed the title Draft: Doc style and link enhancements Doc style and link enhancements Sep 21, 2023
@michelle-purcell michelle-purcell force-pushed the security-doc-fixes-3-2-bearer-concept branch from 4c9ff7a to e328a27 Compare September 22, 2023 10:06
@quarkus-bot quarkus-bot bot added area/dependencies Pull requests that update a dependency file area/vertx labels Sep 22, 2023
@michelle-purcell michelle-purcell force-pushed the security-doc-fixes-3-2-bearer-concept branch 2 times, most recently from 6290efc to 360788a Compare September 22, 2023 12:07
@quarkus-bot

This comment has been minimized.

@michelle-purcell michelle-purcell force-pushed the security-doc-fixes-3-2-bearer-concept branch from 360788a to 2b77327 Compare September 22, 2023 14:05
@quarkus-bot

This comment has been minimized.

@michelle-purcell michelle-purcell force-pushed the security-doc-fixes-3-2-bearer-concept branch 2 times, most recently from 357670d to fe69b70 Compare September 22, 2023 15:12
@michelle-purcell michelle-purcell force-pushed the security-doc-fixes-3-2-bearer-concept branch from fe69b70 to c6b6cb2 Compare September 25, 2023 11:47
@sberyozkin
Copy link
Member

Looks like it was cancelled and I missed merging it.

@sberyozkin
Copy link
Member

It is upstream only though so let me merge it now, though I'll rebase

@sberyozkin sberyozkin force-pushed the security-doc-fixes-3-2-bearer-concept branch from d4559bb to ce6a2f0 Compare October 5, 2023 18:26
@sberyozkin sberyozkin added the triage/waiting-for-ci Ready to merge when CI successfully finishes label Oct 5, 2023
@sberyozkin
Copy link
Member

Hmm, exec-maven-plugin:3.0.0:exec (assemble-downstream-doc) @ quarkus-documentation is hanging, but I think it just finished on my laptop, I was checking Michelle's branch.

@sberyozkin
Copy link
Member

@gsmet I'm not sure why this PR is hanging, I don't see anything in the updated doc that could've caused it. Please review and merge if it looks fine. on PTO tomorrow

@sberyozkin
Copy link
Member

@sheilamjones, @inoxx03, Hi - what is assemble-downstream-doc ? The doc build is hanging and I don't know if I can merge this PR or not

@inoxx03
Copy link

inoxx03 commented Oct 10, 2023

@sberyozkin Thasnk for the head's up. TBH, I have not found the cause yet. trheI'm not sure but assemble-downstream-doc might be one of the post-processing jobs that we use to transform parts of thew upstream doc's AsciiDoc source to get around the downstream publishing system limitations.

I'll come back and investigate further today, just have to finish some release-related tasks.

@sberyozkin sberyozkin force-pushed the security-doc-fixes-3-2-bearer-concept branch from ce6a2f0 to d91871b Compare October 10, 2023 13:00
@sheilamjones
Copy link
Contributor

Apologies for slow reply @sberyozkin. Was tied up with 3.2 release tasks yesterday. Yes, as Stefan suggested, I think the assemble-downstream.doc topic relates to the downstreaming script with the post-processing fixes to enable us to bring the content downstream. Shall investigate further.

@sberyozkin
Copy link
Member

@sheilamjones No problems at all Sheila, thanks for the update.

Unfortunately it is still failing, something in this PR or in some other PRs is causing this task to fail.

@rsvoboda Rostislav, can you spot it ? Your fix is in Michelle's branch: https://github.com/michelle-purcell/quarkus/commits/security-doc-fixes-3-2-bearer-concept

Comment on lines +437 to +438
+
====
Copy link
Member

Choose a reason for hiding this comment

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

This noise makes the build of downstream docs to be stuck

there should be no + and ==== on solo lines

CC @sberyozkin @michelle-purcell

Copy link
Member

@sberyozkin sberyozkin Oct 11, 2023

Choose a reason for hiding this comment

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

@rsvoboda @michelle-purcell It took me may be 5 rounds to get past the downstream task, I've ended up removing all of standalone + and ==== and it looked like it fixed the problem. Michelle, not sure if the end result would be what you expected it to be without these characters, so I guess you should have a look before me merging this PR

Thanks

@github-actions
Copy link

github-actions bot commented Oct 11, 2023

🙈 The PR is closed and the preview is expired.

@sberyozkin sberyozkin force-pushed the security-doc-fixes-3-2-bearer-concept branch from 556808f to d5e32b2 Compare October 12, 2023 09:45
@sberyozkin
Copy link
Member

Michelle, I'm not sure the numbering scheme works, there are a few places with 1. where another .1 follows in the same section after one paragraph etc. Can we consider removing it ?

@michelle-purcell michelle-purcell force-pushed the security-doc-fixes-3-2-bearer-concept branch from d5e32b2 to 8888625 Compare November 1, 2023 11:29
fix typo

Fixes

Minor fixes

fix

fix

remove html file

Peer review fixes

Fixes to section headings level 3

fix

minortweak

Update docs/src/main/asciidoc/security-oidc-bearer-token-authentication.adoc

Co-authored-by: Sergey Beryozkin <sberyozkin@gmail.com>

Update docs/src/main/asciidoc/security-oidc-bearer-token-authentication.adoc

fix
@michelle-purcell
Copy link
Contributor Author

Thanks @sberyozkin. Apologies for not getting to this sooner. Between PTO and other priorities...
Some of the numbering markup edits were introduced to fix bad numbering/style on the downstream publishing output too and to follow the advice in the upstream tutorial/how-to templates.
I will test and investigate today and test the output of the markup on both publishing platforms. Thanks for flagging :-)

@sberyozkin
Copy link
Member

Hi Michelle @michelle-purcell , missed your comment, sorry. Sure please check it

@michelle-purcell
Copy link
Contributor Author

Closing this PR as it has languished and overlaps with other changes. @rolfedh is taking over the edits for this guide in a fresh PR. Thanks @rolfedh. Please see the comments above for your reference. Thanks.

@quarkus-bot quarkus-bot bot added triage/invalid This doesn't seem right and removed triage/waiting-for-ci Ready to merge when CI successfully finishes triage/backport-3.2 labels Nov 30, 2023
@rolfedh
Copy link
Contributor

rolfedh commented Dec 4, 2023

@rolfedh is taking over the edits for this guide in a fresh PR. Thanks @rolfedh. Please see the comments above for your reference. Thanks.

@sheilamjones has taken up revising this guide. I've conveyed this information to her. Thanks.

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 area/oidc triage/invalid This doesn't seem right
Projects
Development

Successfully merging this pull request may close these issues.

6 participants