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

Add instructions for prerequesites to "CONTRIBUTE TO QUARKUS DOCUMENTATION" #33227

Closed
rolfedh opened this issue May 9, 2023 · 1 comment · Fixed by #33234
Closed

Add instructions for prerequesites to "CONTRIBUTE TO QUARKUS DOCUMENTATION" #33227

rolfedh opened this issue May 9, 2023 · 1 comment · Fixed by #33234
Labels
area/documentation kind/enhancement New feature or request
Milestone
3.1.0.CR1

Comments

@rolfedh
Copy link
Contributor

rolfedh commented May 9, 2023

Description

The community docs define prerequisites by using a standard attribute and include statement. For example:

== Prerequisites

:prerequisites-time: 30 minutes
include::{includes}/prerequisites.adoc[]

Our instructions to contributors should include this information.

Implementation ideas

Add instructions for prerequesites to "CONTRIBUTE TO QUARKUS DOCUMENTATION"
docs/src/main/asciidoc/doc-contribute-docs-howto.adoc
@rolfedh rolfedh added the kind/enhancement New feature or request label May 9, 2023
@rolfedh rolfedh mentioned this issue May 9, 2023
Closed
@quarkus-bot
Copy link

quarkus-bot bot commented May 9, 2023

/cc @MichalMaler (documentation), @ebullient (documentation), @hmanwani-rh (documentation), @inoxx03 (documentation), @michelle-purcell (documentation), @sheilamjones (documentation), @sunayna15 (documentation)

@rolfedh rolfedh mentioned this issue May 9, 2023
Merged
@quarkus-bot quarkus-bot bot added this to the 3.1 - main milestone May 15, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
area/documentation kind/enhancement New feature or request
Projects
None yet
Milestone
3.1.0.CR1
Development

Successfully merging a pull request may close this issue.

Add prerequisites to contribution guide plus some copy edits. rolfedh/quarkus
2 participants
@rolfedh @geoand