Skip to content

Commit

Permalink
Clean up the guides
Browse files Browse the repository at this point in the history
- Remove outdated content
- Rename includes/ to _includes/ so that it does not get rendered
- Move all includes to the _includes/ subdirectory
  • Loading branch information
gsmet committed Oct 17, 2022
1 parent faa924c commit 282ac0e
Show file tree
Hide file tree
Showing 237 changed files with 241 additions and 399 deletions.
8 changes: 4 additions & 4 deletions docs/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -2818,14 +2818,14 @@
<directory>src/main/asciidoc</directory>
<filtering>false</filtering>
<excludes>
<exclude>**/attributes.adoc</exclude>
<exclude>**/_attributes.adoc</exclude>
</excludes>
</resource>
<resource>
<directory>src/main/asciidoc</directory>
<filtering>true</filtering>
<includes>
<include>**/attributes.adoc</include>
<include>**/_attributes.adoc</include>
</includes>
</resource>
</resources>
Expand Down Expand Up @@ -2959,8 +2959,8 @@
<skip-front-matter>true</skip-front-matter>
<!--
Attributes are now maintained in:
- src/main/asciidoc-filtered/attributes.adoc for attributes that are actually used in the doc content e.g. versions, urls.
- src/main/asciidoc/attributes-local.adoc for technical attributes that have to be overridden in the website.
- src/main/asciidoc/_attributes.adoc for attributes that are actually used in the doc content e.g. versions, urls.
- src/main/asciidoc/_attributes-local.adoc for technical attributes that have to be overridden in the website.
-->
</attributes>
</configuration>
Expand Down
18 changes: 0 additions & 18 deletions docs/src/main/asciidoc/0-glossary.adoc

This file was deleted.

19 changes: 18 additions & 1 deletion docs/src/main/asciidoc/README.adoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
= README: Quarkus documentation
include::attributes.adoc[]
include::_attributes.adoc[]

Quarkus documentation uses asciidoc syntax.

Expand All @@ -10,3 +10,20 @@ For more information on contributing to Quarkus docs, see:
- xref:doc-contribute-docs-howto.adoc[How to contribute documentation]
- xref:doc-concepts.adoc[Quarkus documentation concepts]
- xref:doc-reference.adoc[Quarkus documentation reference]
== Glossary

This is a collection of preferred term in the documentation and website.
Please stay within these terms for consistency.

* Live coding:: for our `quarkus:dev` capability
* GraalVM native image:: preferred term for the VM creating native executable. No space.
* Substrate VM:: non-preferred. Exclude.
* Native Executable:: the executable that is compiled to native 1s and 0s
* Docker image:: for the actual `Dockerfile` definition and when the tool chain is involved
* Container:: when we discuss Quarkus running in... containers
* Supersonic Subatomic Java:: our tagline
* Kubernetes Native Java:: our preferred tagline to say that we rock for containers
* Developer Joy:: for everything going from live reload to the opinionated layer to a single config file
* Unify Imperative and Reactive:: imperative and reactive. 'Nuff said.
* Best of breed frameworks and standards:: when we explain our stack
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,5 @@
:doc-examples: ./_examples
:generated-dir: ../../../../target/asciidoc/generated
:imagesdir: ./images
:includes: ./includes
:includes: ./_includes
:toc: preamble
Original file line number Diff line number Diff line change
Expand Up @@ -49,4 +49,4 @@
:vault-datasource-guide: https://quarkiverse.github.io/quarkiverse-docs/quarkus-vault/dev/vault-datasource.html
:micrometer-registry-guide: https://quarkiverse.github.io/quarkiverse-docs/quarkus-micrometer-registry/dev/index.html

include::./attributes-local.adoc[]
include::_attributes-local.adoc[]
2 changes: 1 addition & 1 deletion docs/src/main/asciidoc/_templates/template-concepts.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc
TODO: If this is a concept related to an experimental or tech-preview extension, uncomment the following and set the appropriate status (otherwise delete)
:extension-status: preview
////
include::attributes.adoc[]
include::_attributes.adoc[]

A short introduction that summarizes or frames the concept.
This summary should help a reader determine whether or not this document is what they want to read.
Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/asciidoc/_templates/template-howto.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ TODO: Title should have an implied "How to.." in front. See
TODO: If this is a reference for an experimental or tech-preview extension, uncomment the following and set the appropriate status (otherwise delete)
:extension-status: preview
////
include::attributes.adoc[]
include::_attributes.adoc[]

How-to guides are goal-oriented, and should help the reader accomplish a task (where there may be forks in the path).

Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/asciidoc/_templates/template-reference.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc
TODO: If this is a reference for an experimental or tech-preview extension, uncomment the following and set the appropriate status (otherwise delete)
:extension-status: preview
////
include::attributes.adoc[]
include::_attributes.adoc[]

A short introduction that describes the content of this reference.
This summary should help a reader determine if this document is likely to contain the information they are looking for.
Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/asciidoc/_templates/template-tutorial.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc
TODO: If this is a tutorial for an experimental or tech-preview extension, uncomment the following and set the appropriate status (otherwise delete)
:extension-status: preview
////
include::attributes.adoc[]
include::_attributes.adoc[]

Describe what the learner will accomplish (examples: build, create, construct, deploy; not: “you will learn...”).
This short summary should help a reader determine if they want to engage with the content.
Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/asciidoc/all-builditems.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ and pull requests should be submitted there:
https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc
////
= Build Items
include::./attributes.adoc[]
include::_attributes.adoc[]
:categories: writing-extensions
:summary: Explore all the BuildItems you can consume/produce in your extensions.

Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/asciidoc/all-config.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ and pull requests should be submitted there:
https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc
////
= All configuration options
include::./attributes.adoc[]
include::_attributes.adoc[]
:categories: core
:summary: List all the configuration properties per extensions

Expand Down
5 changes: 0 additions & 5 deletions docs/src/main/asciidoc/amazon-credentials.adoc

This file was deleted.

2 changes: 1 addition & 1 deletion docs/src/main/asciidoc/amazon-lambda-http.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
////
= Amazon Lambda with RESTEasy Reactive, Undertow, or Reactive Routes
:extension-status: preview
include::./attributes.adoc[]
include::_attributes.adoc[]
:categories: cloud
:summary: This guide explains how you can deploy Vert.x Web, Servlet, or RESTEasy microservices as an Amazon Lambda.
:devtools-no-gradle:
Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/asciidoc/amazon-lambda.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ and pull requests should be submitted there:
https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc
////
= Amazon Lambda
include::./attributes.adoc[]
include::_attributes.adoc[]
:categories: cloud
:summary: This guide explains how you can deploy Quarkus-based Amazon Lambdas.

Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/asciidoc/amqp-dev-services.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ and pull requests should be submitted there:
https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc
////
= Dev Services for AMQP
include::./attributes.adoc[]
include::_attributes.adoc[]
:categories: messaging
:summary: Start AMQP automatically in dev and test modes.

Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/asciidoc/amqp-reference.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
////
= Reactive Messaging AMQP 1.0 Connector Reference Documentation

include::./attributes.adoc[]
include::_attributes.adoc[]

This guide is the companion from the xref:amqp.adoc[Getting Started with AMQP 1.0].
It explains in more details the configuration and usage of the AMQP connector for reactive messaging.
Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/asciidoc/amqp.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ and pull requests should be submitted there:
https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc
////
= Getting Started to SmallRye Reactive Messaging with AMQP 1.0
include::./attributes.adoc[]
include::_attributes.adoc[]
:categories: messaging
:summary: This guide demonstrates how your Quarkus application can utilize SmallRye Reactive Messaging to interact with AMQP.

Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/asciidoc/apicurio-registry-dev-services.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ and pull requests should be submitted there:
https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc
////
= Dev Services for Apicurio Registry
include::./attributes.adoc[]
include::_attributes.adoc[]
:categories: messaging
:summary: Start Apicurio Registry automatically in dev and test modes.

Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/asciidoc/azure-functions-http.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
////
= Azure Functions (Serverless) with RESTEasy Reactive, Undertow, or Reactive Routes
:extension-status: preview
include::./attributes.adoc[]
include::_attributes.adoc[]
:categories: cloud
:summary: This guide explains how you can deploy Vert.x Web, Servlet, or RESTEasy microservices as an Azure Function.

Expand Down
6 changes: 3 additions & 3 deletions docs/src/main/asciidoc/blaze-persistence.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ and pull requests should be submitted there:
https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc
////
= Using Blaze-Persistence
include::./attributes.adoc[]
include::_attributes.adoc[]
:categories: data
:summary: This guide explains how to use Blaze-Persistence to simplify your data and DTO layers.
:config-file: application.properties
Expand All @@ -17,7 +17,7 @@ queries which are then transformed to optimized queries that only fetch the data
The same DTO definitions can further be used for applying database updates, leading to a great reduction in boilerplate
code and removing the need for object mapping tools.

include::./platform-include.adoc[]
include::{includes}/platform-include.adoc[]

== Setting up and configuring Blaze-Persistence

Expand Down Expand Up @@ -223,7 +223,7 @@ When no property is set, the Blaze-Persistence defaults apply.

The configuration properties listed here allow you to override such defaults, and customize and tune various aspects.

include::quarkus-blaze-persistence.adoc[opts=optional, leveloffset=+2]
include::{includes}/quarkus-blaze-persistence.adoc[opts=optional, leveloffset=+2]

Apart from these configuration options, further configuration and customization can be applied by observing a `CriteriaBuilderConfiguration` or `EntityViewConfiguration` events and applying customizations on these objects. The various customization use cases can be found in the link:https://persistence.blazebit.com/documentation/entity-view/manual/en_US/index.html#quarkus-customization[Quarkus section of the entity-view documentation].

Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/asciidoc/building-my-first-extension.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ and pull requests should be submitted there:
https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc
////
= Building my first extension
include::./attributes.adoc[]
include::_attributes.adoc[]
:categories: writing-extensions
:summary: Learn step by step how to build a simple extension.

Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/asciidoc/building-native-image.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ and pull requests should be submitted there:
https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc
////
= Building a Native Executable
include::./attributes.adoc[]
include::_attributes.adoc[]
:categories: getting-started
:summary: Build native executables with GraalVM or Mandrel.

Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/asciidoc/cache.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
////
= Application Data Caching
:extension-status: preview
include::./attributes.adoc[]
include::_attributes.adoc[]
:categories: data
:summary: This guide explains how to cache expensive method calls of your CDI beans using simple annotations.

Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/asciidoc/camel.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ and pull requests should be submitted there:
https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc
////
= Apache Camel on Quarkus
include::./attributes.adoc[]
include::_attributes.adoc[]
:categories: integration
:summary: This guide covers the systems integration with Apache Camel

Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/asciidoc/capabilities.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ and pull requests should be submitted there:
https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc
////
= Extension Capabilities
include::./attributes.adoc[]
include::_attributes.adoc[]
:categories: writing-extensions
:summary: How capabilities are implemented and used in Quarkus.

Expand Down
4 changes: 2 additions & 2 deletions docs/src/main/asciidoc/cassandra.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ and pull requests should be submitted there:
https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc
////
= Using the Cassandra Client
include::./attributes.adoc[]
include::_attributes.adoc[]
:categories: data
:summary: This guide covers how to use the Apache Cassandra NoSQL database in Quarkus.

Expand All @@ -14,7 +14,7 @@ high availability with no single point of failure.

In this guide, we will see how you can get your REST services to use a Cassandra database.

include::./platform-include.adoc[]
include::{includes}/platform-include.adoc[]

== Prerequisites

Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/asciidoc/cdi-integration.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc
= CDI Integration Guide
:categories: writing-extensions
:summary: Learn how to integrate your extension with Quarkus' CDI container.
include::./attributes.adoc[]
include::_attributes.adoc[]
:numbered:
:toc:
:toclevels: 2
Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/asciidoc/cdi-reference.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ and pull requests should be submitted there:
https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc
////
= Contexts and Dependency Injection
include::./attributes.adoc[]
include::_attributes.adoc[]
:categories: core
:summary: Go more in depth into the Quarkus implementation of CDI.
:numbered:
Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/asciidoc/cdi.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ and pull requests should be submitted there:
https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc
////
= Introduction to Contexts and Dependency Injection
include::./attributes.adoc[]
include::_attributes.adoc[]
:categories: core
:summary: Quarkus DI solution is based on the [Contexts and Dependency Injection for Java 2.0](https://docs.jboss.org/cdi/spec/2.0/cdi-spec) specification. This guide explains the basics of CDI.
:numbered:
Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/asciidoc/centralized-log-management.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ and pull requests should be submitted there:
https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc
////
= Centralized log management (Graylog, Logstash, Fluentd)
include::./attributes.adoc[]
include::_attributes.adoc[]
:categories: observability
:summary: This guide explains how to centralize your logs with Logstash or Fluentd using the Graylog Extended Log Format (GELF).

Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/asciidoc/class-loading-reference.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ and pull requests should be submitted there:
https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc
////
= Class Loading Reference
include::./attributes.adoc[]
include::_attributes.adoc[]
:categories: architecture
:summary: Learn more about Quarkus class loading infrastructure.

Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/asciidoc/cli-tooling.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
////
= Building Quarkus apps with Quarkus Command Line Interface (CLI)
:extension-status: preview
include::./attributes.adoc[]
include::_attributes.adoc[]
:categories: tooling
:summary: Use the Quarkus CLI to create, build, run, and manage extensions for Quarkus projects.

Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/asciidoc/command-mode-reference.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ and pull requests should be submitted there:
https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc
////
= Command Mode Applications
include::./attributes.adoc[]
include::_attributes.adoc[]
:categories: core, command-line
:summary: This reference guide explains how to develop command line applications with Quarkus.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ and pull requests should be submitted there:
https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc
////
= Conditional Extension Dependencies
include::./attributes.adoc[]
include::_attributes.adoc[]
:categories: writing-extensions
:summary: Trigger the inclusion on additional extensions based on certain conditions.

Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/asciidoc/config-extending-support.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ and pull requests should be submitted there:
https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc
////
= Extending Configuration Support
include::./attributes.adoc[]
include::_attributes.adoc[]
:categories: core
:summary: Extend and customize the Configuration.
:numbered:
Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/asciidoc/config-mappings.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ and pull requests should be submitted there:
https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc
////
= Mapping configuration to objects
include::./attributes.adoc[]
include::_attributes.adoc[]
:categories: core
:summary: Group multiple configuration properties into an object.
:numbered:
Expand Down
Loading

0 comments on commit 282ac0e

Please sign in to comment.