-
Notifications
You must be signed in to change notification settings - Fork 2.7k
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
Added guidance for diataxis templates & xrefs #33981
Merged
ebullient
merged 1 commit into
quarkusio:main
from
michelle-purcell:DOC-CROSS-REFERENCE-GUIDELINES
Jun 13, 2023
+67
−25
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Added guidance for diataxis templates & xrefs
Fix one sentence per line Fix issues with sections Fix structure Update docs/src/main/asciidoc/doc-reference.adoc Co-authored-by: sheilamjones <87032823+sheilamjones@users.noreply.github.com> Update docs/src/main/asciidoc/doc-reference.adoc Co-authored-by: sheilamjones <87032823+sheilamjones@users.noreply.github.com>
- 3.17.5
- 3.17.4
- 3.17.3
- 3.17.2
- 3.17.1
- 3.17.0
- 3.17.0.CR1
- 3.16.4
- 3.16.3
- 3.16.2
- 3.16.1
- 3.16.0
- 3.16.0.CR1
- 3.15.2
- 3.15.1
- 3.15.0
- 3.15.0.CR1
- 3.14.4
- 3.14.3
- 3.14.2
- 3.14.1
- 3.14.0
- 3.14.0.CR1
- 3.13.3
- 3.13.2
- 3.13.1
- 3.13.0
- 3.13.0.CR1
- 3.12.3
- 3.12.2
- 3.12.1
- 3.12.0
- 3.12.0.CR1
- 3.11.3
- 3.11.2
- 3.11.1
- 3.11.0
- 3.11.0.CR1
- 3.10.2
- 3.10.1
- 3.10.0
- 3.10.0.CR1
- 3.9.5
- 3.9.4
- 3.9.3
- 3.9.2
- 3.9.1
- 3.9.0
- 3.9.0.CR2
- 3.9.0.CR1
- 3.8.6
- 3.8.5
- 3.8.4
- 3.8.3
- 3.8.2
- 3.8.1
- 3.8.0
- 3.8.0.CR1
- 3.7.4
- 3.7.3
- 3.7.2
- 3.7.1
- 3.7.0
- 3.7.0.CR1
- 3.6.9
- 3.6.8
- 3.6.7
- 3.6.6
- 3.6.5
- 3.6.4
- 3.6.3
- 3.6.2
- 3.6.1
- 3.6.0
- 3.6.0.CR1
- 3.5.3
- 3.5.2
- 3.5.1
- 3.5.0
- 3.5.0.CR1
- 3.4.3
- 3.4.2
- 3.4.1
- 3.4.0
- 3.4.0.CR1
- 3.3.3
- 3.3.2
- 3.3.1
- 3.3.0
- 3.3.0.CR1
- 3.2.12.Final
- 3.2.11.Final
- 3.2.10.Final
- 3.2.9.Final
- 3.2.8.Final
- 3.2.7.Final
- 3.2.6.Final
- 3.2.5.Final
- 3.2.4.Final
- 3.2.3.Final
- 3.2.2.Final
- 3.2.1.Final
- 3.2.0.Final
- 3.2.0.CR1
commit 5d6eb00a5b6b5ad778c71f82e86941cf1b0e5e36
There are no files selected for viewing
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
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
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.
There was a problem hiding this comment.
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====
?There was a problem hiding this comment.
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?