Skip to content

Commit

Permalink
Added prereqs to the how to template
Browse files Browse the repository at this point in the history
  • Loading branch information
rolfedh committed May 16, 2023
1 parent f7af2e5 commit d8ef18f
Showing 1 changed file with 16 additions and 3 deletions.
19 changes: 16 additions & 3 deletions docs/src/main/asciidoc/_templates/template-howto.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc
////
////
TODO: See xref:{doc-guides}/doc-reference.adoc[Quarkus style and content guidelines] for details
- Title should have an implied "How to..." in front.
- Title should have an implied "How to..." in front.
- ID should end with '-howto' (using the filename works)
- choose appropriate categories
////
Expand All @@ -15,7 +15,7 @@ include::_attributes.adoc[]
:categories: ...
////
:extension-status: preview
TODO: uncomment the above for experimental or tech-preview content.
TODO: uncomment the above for experimental or tech-preview content.
The document header ends at the first blank line. Do not remove the blank line between the header and the abstract summary.
////

Expand All @@ -26,6 +26,17 @@ TODO: If this is a reference for an experimental or tech-preview extension, unco
include::{includes}/extension-status.adoc[]
////

== Prerequisites

////
TODO: If this tutorial will use dev tools, use the following common include:
include::{includes}/devtools/prerequisites.adoc[]
This file offers a few different variables that can be used to tweak what is shown.
////

- Materials, software, ...
- Whatever they should already have in hand to complete this set of steps

== Define the problem

Your user will also be in the middle of something: define the starting-point that they know how to reach and a conclusion that answers a real question.
Expand All @@ -49,6 +60,8 @@ To create anchors for in-file and cross-file navigation, see the following detai
- Don’t explain concepts; link to a related concept/explainer.
- Be flexible; a how-to guide needs to be adaptable to real-world use cases.
- Omit the unnecessary; practical usability is more helpful than completeness.
- A how-to guide can include multiple tasks, each with its own H2 heading.
- For suggestions on how to write a good how-to guide, see https://diataxis.fr/how-to-guides/#writing-a-good-how-to-guide.

== Examples

Expand All @@ -57,4 +70,4 @@ For example, "How to use Jackson annotations" is answered (with variations) here

== References

To help direct the reader to more information about the content topic, optionally add a *References* section to the end of the page and include `links` or `xrefs` to other related content resources.
To help direct the reader to more information about the content topic, optionally add a *References* section to the end of the page and include `links` or `xrefs` to other related content resources.

0 comments on commit d8ef18f

Please sign in to comment.