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

Added guidance for diataxis templates & xrefs #33981

Merged
merged 1 commit into from
Jun 13, 2023
Merged

Added guidance for diataxis templates & xrefs #33981

merged 1 commit into from
Jun 13, 2023

Conversation

michelle-purcell
Copy link
Contributor

No description provided.

@michelle-purcell michelle-purcell force-pushed the DOC-CROSS-REFERENCE-GUIDELINES branch from a0bfbbd to 6eaec68 Compare June 12, 2023 12:27
ebullient
ebullient approved these changes Jun 12, 2023
View reviewed changes
docs/src/main/asciidoc/doc-reference.adoc
@@ -234,6 +243,10 @@ https://docs.asciidoctor.org/asciidoc/latest/syntax-quick-reference/[AsciiDoc Sy
The above source produces this link:https://docs.asciidoctor.org/asciidoc/latest/syntax-quick-reference/[AsciiDoc Syntax Quick Reference,window=_blank,opts=nofollow].
=====

[[cross-references]]
=== Cross-references

Copy link
Member

Choose a reason for hiding this comment

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

Doubled?

Should this be a == heading? Or should the following heading (phrasing) be ==== ?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@ebullient - Thanks Erin for reviewing. Sorry I missed that 🌳 You are absolutely correct 👍

I pushed further change just now to promote the sections Links, Cross-references, and Source code and configuration examples from === to == and out of the Document structure section as they are big enough & popular topics in their own right. WDYT?

image

@michelle-purcell michelle-purcell force-pushed the DOC-CROSS-REFERENCE-GUIDELINES branch from 6eaec68 to 0f5130c Compare June 12, 2023 16:29
@quarkus-bot quarkus-bot bot added the area/qute The template engine label Jun 12, 2023
@michelle-purcell michelle-purcell force-pushed the DOC-CROSS-REFERENCE-GUIDELINES branch from 0f5130c to 3f09cc2 Compare June 12, 2023 16:30
@sheilamjones
Copy link
Contributor

Thanks @michelle-purcell for adding these updates. Super job and they will be very helpful. I just had a couple of minor comments for your consideration.

@michelle-purcell
Copy link
Contributor Author

@sheilamjones & @ebullient - Thank you so much for your prompt reviews. I think I have resolved all of your comments.
If you are happy with the adjustment to the section headings then we can go ahead and merge this one.

rolfedh
rolfedh approved these changes Jun 12, 2023
View reviewed changes
Copy link
Contributor

@rolfedh rolfedh left a comment

Choose a reason for hiding this comment

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

LGTM! Great work, @michelle-purcell!

@github-actions
Copy link

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

🙈 The PR is closed and the preview is expired.

ebullient
ebullient requested changes Jun 12, 2023
View reviewed changes
Copy link
Member

@ebullient ebullient left a comment

Choose a reason for hiding this comment

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

Must resolve merge commit

@michelle-purcell michelle-purcell force-pushed the DOC-CROSS-REFERENCE-GUIDELINES branch from 4fc6080 to b529742 Compare June 13, 2023 06:55
@michelle-purcell @sheilamjones
Added guidance for diataxis templates & xrefs
5d6eb00 
Fix one sentence per line

Fix issues with sections

Fix structure

Update docs/src/main/asciidoc/doc-reference.adoc

Co-authored-by: sheilamjones <[email protected]>

Update docs/src/main/asciidoc/doc-reference.adoc

Co-authored-by: sheilamjones <[email protected]>
@michelle-purcell michelle-purcell force-pushed the DOC-CROSS-REFERENCE-GUIDELINES branch from b529742 to 5d6eb00 Compare June 13, 2023 06:57
@michelle-purcell
Copy link
Contributor Author

@ebullient - Self-inflicted conflicts are now resolved 😉

@quarkus-bot
Copy link

quarkus-bot bot commented Jun 13, 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.

@ebullient ebullient merged commit 09b073b into quarkusio:main Jun 13, 2023
@quarkus-bot quarkus-bot bot added this to the 3.2 - main milestone Jun 13, 2023
@michelle-purcell michelle-purcell deleted the DOC-CROSS-REFERENCE-GUIDELINES branch June 13, 2023 11:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sheilamjones sheilamjones sheilamjones left review comments

@ebullient ebullient ebullient approved these changes

@rolfedh rolfedh rolfedh approved these changes

Assignees
No one assigned
Labels
area/core area/documentation area/qute The template engine
Projects
None yet
Milestone
3.2.0.CR1
Development

Successfully merging this pull request may close these issues.
4 participants
@michelle-purcell @sheilamjones @rolfedh @ebullient