Skip to content

Commit

Permalink
Merge pull request #34857 from gsmet/identify-links-with-attributes
Browse files Browse the repository at this point in the history
Make sure links starting with attributes are identifiable
  • Loading branch information
gsmet authored Jul 21, 2023
2 parents c0307ba + d934496 commit 66373fb
Show file tree
Hide file tree
Showing 84 changed files with 120 additions and 120 deletions.
2 changes: 1 addition & 1 deletion docs/src/main/asciidoc/amqp.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ However, you can go right to the completed example.

Clone the Git repository: `git clone {quickstarts-clone-url}`, or download an {quickstarts-archive-url}[archive].

The solution is located in the `amqp-quickstart` {quickstarts-tree-url}/amqp-quickstart[directory].
The solution is located in the `amqp-quickstart` link:{quickstarts-tree-url}/amqp-quickstart[directory].

== Creating the Maven Project

Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/asciidoc/ansible.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ include::_attributes.adoc[]

Let’s see how to build and deploy a Quarkus app using https://docs.ansible.com/ansible/latest/index.html[Ansible]. We’ll see how we can automate the entire process, from the code checkout to the application compilation using Maven and then its deployment and start of the service, as a https://systemd.io/[systemd service], on the target system using Ansible and its collection for Quarkus.

The first part, the application code checkout, compilation and packaging on the Ansible (where Ansible runs). We’ll use the getting-started sample application provided in its {quickstarts-tree-url}/getting-started[Quarkus QuickStarts directory] as a base for this tutorial. We’ll also leverage the https://galaxy.ansible.com/middleware_automation/quarkus[Quarkus collection] for Ansible, an extension for Ansible that alleviates the boilerplate required and to quickly build and deploy a Quarkus using Ansible.
The first part, the application code checkout, compilation and packaging on the Ansible (where Ansible runs). We’ll use the getting-started sample application provided in its link:{quickstarts-tree-url}/getting-started[Quarkus QuickStarts directory] as a base for this tutorial. We’ll also leverage the https://galaxy.ansible.com/middleware_automation/quarkus[Quarkus collection] for Ansible, an extension for Ansible that alleviates the boilerplate required and to quickly build and deploy a Quarkus using Ansible.

== Prerequisites

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 @@ -39,7 +39,7 @@ However, you can go right to the completed example.

Clone the Git repository: `git clone {quickstarts-clone-url}`, or download an {quickstarts-archive-url}[archive].

The solution is located in the `cache-quickstart` {quickstarts-tree-url}/cache-quickstart[directory].
The solution is located in the `cache-quickstart` link:{quickstarts-tree-url}/cache-quickstart[directory].

== Creating the Maven project

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 @@ -17,7 +17,7 @@ However, you can go right to the completed example.

Clone the Git repository: `git clone {quickstarts-clone-url}`, or download an {quickstarts-archive-url}[archive].

The solution is located in the `getting-started-command-mode` {quickstarts-tree-url}/getting-started-command-mode[directory].
The solution is located in the `getting-started-command-mode` link:{quickstarts-tree-url}/getting-started-command-mode[directory].

== Creating the Maven project

Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/asciidoc/config.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ However, you can go right to the completed example.

Clone the Git repository: `git clone {quickstarts-clone-url}`, or download an {quickstarts-archive-url}[archive].

The solution is located in the `config-quickstart` {quickstarts-tree-url}/config-quickstart[directory].
The solution is located in the `config-quickstart` link:{quickstarts-tree-url}/config-quickstart[directory].

== Create the Maven project

Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/asciidoc/context-propagation.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ However, you can go right to the completed example.

Clone the Git repository: `git clone {quickstarts-clone-url}`, or download an {quickstarts-archive-url}[archive].

The solution is located in the `context-propagation-quickstart` {quickstarts-tree-url}/context-propagation-quickstart[directory].
The solution is located in the `context-propagation-quickstart` link:{quickstarts-tree-url}/context-propagation-quickstart[directory].

== Setting it up

Expand Down
4 changes: 2 additions & 2 deletions docs/src/main/asciidoc/doc-contribute-docs-howto.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@ Quarkus docs use link:https://asciidoc.org/[AsciiDoc] markup.

== Locate the source files for Quarkus docs

- AsciiDoc files are in the `src/main/asciidoc` directory within the `docs` module of the {quarkus-base-url}/tree/main/docs[Quarkus GitHub repository].
- The Quarkus doc templates are located in the `src/main/asciidoc/_templates` directory within the `docs` module of the {quarkus-base-url}/tree/main/docs[Quarkus GitHub repository].
- AsciiDoc files are in the `src/main/asciidoc` directory within the `docs` module of the link:{quarkus-base-url}/tree/main/docs[Quarkus GitHub repository].
- The Quarkus doc templates are located in the `src/main/asciidoc/_templates` directory within the `docs` module of the link:{quarkus-base-url}/tree/main/docs[Quarkus GitHub repository].
- Configuration documentation is generated from JavaDoc comments in Java source files.
- Java, YAML, and other source files can also be xref:doc-reference.adoc#reference-source-code[referenced] by AsciiDoc files.
- The link:https://quarkus.io/guides/[Quarkus documentation] menu page, also known as the doc index page, is sourced in the link:https://github.com/quarkusio/quarkusio.github.io[quarkusio.github.io] repository.
Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/asciidoc/doc-reference.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ Your titles and headings must also follow the specific guidance for the Quarkus

=== Source locations

- AsciiDoc files are in the `src/main/asciidoc` directory within the `docs` module of the {quarkus-base-url}/tree/main/docs[Quarkus GitHub repository].
- AsciiDoc files are in the `src/main/asciidoc` directory within the `docs` module of the link:{quarkus-base-url}/tree/main/docs[Quarkus GitHub repository].
- Configuration documentation is generated from JavaDoc comments in Java source files.
- Java, YAML, and other source files can also be referenced by AsciiDoc files.

Expand Down
4 changes: 2 additions & 2 deletions docs/src/main/asciidoc/funqy-aws-lambda-http.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -31,12 +31,12 @@ there's also a quickstart for running Funqy HTTP on AWS Lambda.

Clone the Git repository: `git clone {quickstarts-clone-url}`, or download an {quickstarts-archive-url}[archive].

The solution is located in the `funqy-amazon-lambda-quickstart` {quickstarts-tree-url}/funqy-quickstarts/funqy-amazon-lambda-http-quickstart[directory].
The solution is located in the `funqy-amazon-lambda-quickstart` link:{quickstarts-tree-url}/funqy-quickstarts/funqy-amazon-lambda-http-quickstart[directory].

== The Code

There is nothing special about the code and more importantly nothing AWS specific. Funqy functions can be deployed to many
environments and AWS Lambda is one of them. The Java code is actually the same exact code as the {quickstarts-tree-url}/funqy-quickstarts/funqy-http-quickstart[funqy-http-quickstart].
environments and AWS Lambda is one of them. The Java code is actually the same exact code as the link:{quickstarts-tree-url}/funqy-quickstarts/funqy-http-quickstart[funqy-http-quickstart].

== Getting Started

Expand Down
8 changes: 4 additions & 4 deletions docs/src/main/asciidoc/funqy-aws-lambda.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -37,12 +37,12 @@ for installing AWS CLI.

Clone the Git repository: `git clone {quickstarts-clone-url}`, or download an {quickstarts-archive-url}[archive].

The solution is located in the `funqy-amazon-lambda-quickstart` {quickstarts-tree-url}/funqy-quickstarts/funqy-amazon-lambda-quickstart[directory].
The solution is located in the `funqy-amazon-lambda-quickstart` link:{quickstarts-tree-url}/funqy-quickstarts/funqy-amazon-lambda-quickstart[directory].

== The Code

There is nothing special about the code and more importantly nothing AWS specific. Funqy functions can be deployed to many
environments and AWS Lambda is one of them. The Java code is actually the same exact code as the {quickstarts-tree-url}/funqy-quickstarts/funqy-http-quickstart[funqy-http-quickstart].
environments and AWS Lambda is one of them. The Java code is actually the same exact code as the link:{quickstarts-tree-url}/funqy-quickstarts/funqy-http-quickstart[funqy-http-quickstart].

[[choose]]
== Choose Your Function
Expand All @@ -55,7 +55,7 @@ within your project, then you will need to choose the function within your Quark
quarkus.funqy.export=greet
----

You can see how the quickstart has done it within its own {quickstarts-tree-url}/funqy-quickstarts/funqy-amazon-lambda-quickstart/src/main/resources/application.properties[application.properties].
You can see how the quickstart has done it within its own link:{quickstarts-tree-url}/funqy-quickstarts/funqy-amazon-lambda-quickstart/src/main/resources/application.properties[application.properties].

Alternatively, you can set the `QUARKUS_FUNQY_EXPORT` environment variable when you create the AWS Lambda using the `aws` cli.

Expand Down Expand Up @@ -234,7 +234,7 @@ Funqy AWS Lambda support leverages the Quarkus AWS Lambda test framework so that
This is true for both JVM and native modes.
This test framework provides similar functionality to the SAM CLI, without the overhead of Docker.

If you open up {quickstarts-tree-url}/funqy-quickstarts/funqy-amazon-lambda-quickstart/src/test/java/org/acme/funqy/FunqyTest.java[FunqyTest.java]
If you open up link:{quickstarts-tree-url}/funqy-quickstarts/funqy-amazon-lambda-quickstart/src/test/java/org/acme/funqy/FunqyTest.java[FunqyTest.java]
you'll see that the test replicates the AWS execution environment.

[source,java]
Expand Down
4 changes: 2 additions & 2 deletions docs/src/main/asciidoc/funqy-gcp-functions-http.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -31,12 +31,12 @@ there's also a quickstart for running Funqy HTTP on Google Cloud Functions.

Clone the Git repository: `git clone {quickstarts-clone-url}`, or download an {quickstarts-archive-url}[archive].

The solution is located in the `funqy-google-cloud-functions-http-quickstart` {quickstarts-tree-url}/funqy-quickstarts/funqy-google-cloud-functions-http-quickstart[directory].
The solution is located in the `funqy-google-cloud-functions-http-quickstart` link:{quickstarts-tree-url}/funqy-quickstarts/funqy-google-cloud-functions-http-quickstart[directory].

== The Code

There is nothing special about the code and more importantly nothing Google Cloud specific. Funqy functions can be deployed to many
environments and Google Cloud Functions is one of them. The Java code is actually the same exact code as the {quickstarts-tree-url}/funqy-quickstarts/funqy-http-quickstart[funqy-http-quickstart].
environments and Google Cloud Functions is one of them. The Java code is actually the same exact code as the link:{quickstarts-tree-url}/funqy-quickstarts/funqy-http-quickstart[funqy-http-quickstart].

== Getting Started

Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/asciidoc/funqy-gcp-functions.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ gcloud auth login

Clone the Git repository: `git clone {quickstarts-clone-url}`, or download an {quickstarts-archive-url}[archive].

The solution is located in the `funqy-google-cloud-functions-quickstart` {quickstarts-tree-url}/funqy-quickstarts/funqy-google-cloud-functions-quickstart[directory].
The solution is located in the `funqy-google-cloud-functions-quickstart` link:{quickstarts-tree-url}/funqy-quickstarts/funqy-google-cloud-functions-quickstart[directory].

== Creating the Maven Deployment Project

Expand Down
10 changes: 5 additions & 5 deletions docs/src/main/asciidoc/funqy-http.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ include::{includes}/prerequisites.adoc[]

Clone the Git repository: `git clone {quickstarts-clone-url}`, or download an {quickstarts-archive-url}[archive].

The solution is located in the `funqy-http-quickstart` {quickstarts-tree-url}/funqy-quickstarts/funqy-http-quickstart[directory].
The solution is located in the `funqy-http-quickstart` link:{quickstarts-tree-url}/funqy-quickstarts/funqy-http-quickstart[directory].

== The Code

Expand Down Expand Up @@ -66,11 +66,11 @@ The HTTP POST or GET methods can be used to invoke on a function. The return va
is marshalled to JSON using the Jackson JSON library. Jackson annotations can be used. If your function
has an input parameter, a POST invocation must use JSON as the input type. Jackson is also used here for unmarshalling.

You can invoke the `hello` function defined in {quickstarts-tree-url}/funqy-quickstarts/funqy-http-quickstart/src/main/java/org/acme/funqy/PrimitiveFunctions.java[PrimitiveFunctions.java]
You can invoke the `hello` function defined in link:{quickstarts-tree-url}/funqy-quickstarts/funqy-http-quickstart/src/main/java/org/acme/funqy/PrimitiveFunctions.java[PrimitiveFunctions.java]
by pointing your browser to http://localhost:8080/hello

Invoking the other functions in the quickstart requires an HTTP POST.
To execute the `greet` function defined in {quickstarts-tree-url}/funqy-quickstarts/funqy-http-quickstart/src/main/java/org/acme/funqy/GreetingFunction.java[GreetingFunction.java]
To execute the `greet` function defined in link:{quickstarts-tree-url}/funqy-quickstarts/funqy-http-quickstart/src/main/java/org/acme/funqy/GreetingFunction.java[GreetingFunction.java]
invoke this curl script.

[source,bash]
Expand All @@ -82,7 +82,7 @@ curl "http://localhost:8080/greet" \
----

Primitive types can also be passed as input using the standard JSON mapping for them.
To execute the `toLowerCase` function defined in {quickstarts-tree-url}/funqy-quickstarts/funqy-http-quickstart/src/main/java/org/acme/funqy/PrimitiveFunctions.java[PrimitiveFunctions.java]
To execute the `toLowerCase` function defined in link:{quickstarts-tree-url}/funqy-quickstarts/funqy-http-quickstart/src/main/java/org/acme/funqy/PrimitiveFunctions.java[PrimitiveFunctions.java]
invoke this curl script:

[source,bash]
Expand All @@ -93,7 +93,7 @@ curl "http://localhost:8080/toLowerCase" \
-d '"HELLO WORLD"'
----

To execute the `double` function defined in {quickstarts-tree-url}/funqy-quickstarts/funqy-http-quickstart/src/main/java/org/acme/funqy/PrimitiveFunctions.java[PrimitiveFunctions.java]
To execute the `double` function defined in link:{quickstarts-tree-url}/funqy-quickstarts/funqy-http-quickstart/src/main/java/org/acme/funqy/PrimitiveFunctions.java[PrimitiveFunctions.java]
invoke this curl script:

[source,bash]
Expand Down
12 changes: 6 additions & 6 deletions docs/src/main/asciidoc/funqy-knative-events.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ The Cloud Event link:https://cloudevents.io/[specification] is a good read to gi

Clone the Git repository: `git clone {quickstarts-clone-url}`, or download an {quickstarts-archive-url}[archive].

The solution is located in the `funqy-knative-events-quickstart` {quickstarts-tree-url}/funqy-quickstarts/funqy-knative-events-quickstart[directory].
The solution is located in the `funqy-knative-events-quickstart` link:{quickstarts-tree-url}/funqy-quickstarts/funqy-knative-events-quickstart[directory].

== The Quickstart Flow

Expand All @@ -64,7 +64,7 @@ Java parameters and return types of your functions.
== The Code

Let's start looking at our quickstart code so that you can understand how Knative Events map to Funqy.
Open up {quickstarts-tree-url}/funqy-quickstarts/funqy-knative-events-quickstart/src/main/java/org/acme/funqy/SimpleFunctionChain.java[SimpleFunctionChain.java]
Open up link:{quickstarts-tree-url}/funqy-quickstarts/funqy-knative-events-quickstart/src/main/java/org/acme/funqy/SimpleFunctionChain.java[SimpleFunctionChain.java]

The first function we'll look at is `defaultChain`.

Expand Down Expand Up @@ -103,7 +103,7 @@ public class SimpleFunctionChain {
}
----

The `configChain` function has its Cloud Event mapping changed by configuration within {quickstarts-tree-url}/funqy-quickstarts/funqy-knative-events-quickstart/src/main/resources/application.properties[application.properties].
The `configChain` function has its Cloud Event mapping changed by configuration within link:{quickstarts-tree-url}/funqy-quickstarts/funqy-knative-events-quickstart/src/main/resources/application.properties[application.properties].


[source,properties,subs=attributes+]
Expand Down Expand Up @@ -179,7 +179,7 @@ public interface CloudEvent {

== Maven

If you look at the {quickstarts-tree-url}/funqy-quickstarts/funqy-knative-events-quickstart/pom.xml[POM],
If you look at the link:{quickstarts-tree-url}/funqy-quickstarts/funqy-knative-events-quickstart/pom.xml[POM],
you'll see that it is a typical Quarkus POM that pulls in one Funqy dependency:

[source,xml]
Expand All @@ -197,7 +197,7 @@ using the same invocation model as
xref:funqy-http.adoc[Funqy HTTP] using normal HTTP requests, or Cloud Event Binary mode, or Structured Mode. All
invocation modes are supported at the same time.

So, if you open up the unit test code in {quickstarts-tree-url}/funqy-quickstarts/funqy-knative-events-quickstart/src/test/java/org/acme/funqy/FunqyTest.java[FunqyTest.java]
So, if you open up the unit test code in link:{quickstarts-tree-url}/funqy-quickstarts/funqy-knative-events-quickstart/src/test/java/org/acme/funqy/FunqyTest.java[FunqyTest.java]
you'll see that its simply using RestAssured to make HTTP invocations to test the functions.

Funqy also works with Quarkus Dev mode!
Expand Down Expand Up @@ -242,7 +242,7 @@ The broker we have created is called `default`, this broker will receive the clo
The broker is also referenced in the function YAML files.

The second step is to define a Kubernetes/OpenShift service to point to the Docker image you created and pushed
during build. Take a look at {quickstarts-tree-url}/funqy-quickstarts/funqy-knative-events-quickstart/src/main/k8s/funqy-service.yaml[funqy-service.yaml]
during build. Take a look at link:{quickstarts-tree-url}/funqy-quickstarts/funqy-knative-events-quickstart/src/main/k8s/funqy-service.yaml[funqy-service.yaml]

[source, yaml]
----
Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/asciidoc/gcp-functions-http.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ If you don't want to follow all these steps, you can go right to the completed e

Clone the Git repository: `git clone {quickstarts-clone-url}`, or download an {quickstarts-archive-url}[archive].

The solution is located in the `google-cloud-functions-http-quickstart` {quickstarts-tree-url}/google-cloud-functions-http-quickstart[directory].
The solution is located in the `google-cloud-functions-http-quickstart` link:{quickstarts-tree-url}/google-cloud-functions-http-quickstart[directory].

== Creating the Maven Deployment Project

Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/asciidoc/gcp-functions.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ If you don't want to follow all these steps, you can go right to the completed e

Clone the Git repository: `git clone {quickstarts-clone-url}`, or download an {quickstarts-archive-url}[archive].

The solution is located in the `google-cloud-functions-quickstart` {quickstarts-tree-url}/google-cloud-functions-quickstart[directory].
The solution is located in the `google-cloud-functions-quickstart` link:{quickstarts-tree-url}/google-cloud-functions-quickstart[directory].


== Creating the Maven Deployment Project
Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/asciidoc/getting-started-testing.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ However, you can go right to the completed example.

Clone the Git repository: `git clone {quickstarts-clone-url}`, or download an {quickstarts-archive-url}[archive].

The solution is located in the `getting-started-testing` {quickstarts-tree-url}/getting-started-testing[directory].
The solution is located in the `getting-started-testing` link:{quickstarts-tree-url}/getting-started-testing[directory].

This guide assumes you already have the completed application from the `getting-started` directory.

Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/asciidoc/getting-started.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ Download an {quickstarts-archive-url}[archive] or clone the git repository:
git clone {quickstarts-clone-url}
----

The solution is located in the `getting-started` {quickstarts-tree-url}/getting-started[directory].
The solution is located in the `getting-started` link:{quickstarts-tree-url}/getting-started[directory].

== Bootstrapping the project

Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/asciidoc/grpc-getting-started.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ However, you can go right to the completed example.

Clone the Git repository: `git clone {quickstarts-clone-url}`, or download an {quickstarts-archive-url}[archive].

The solution is located in the `grpc-plain-text-quickstart` {quickstarts-tree-url}/grpc-plain-text-quickstart[directory].
The solution is located in the `grpc-plain-text-quickstart` link:{quickstarts-tree-url}/grpc-plain-text-quickstart[directory].

== Configuring your project

Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/asciidoc/hibernate-orm-panache-kotlin.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ However, you can go right to the completed example.

Clone the Git repository: `git clone {quickstarts-clone-url}`, or download an {quickstarts-archive-url}[archive].

The solution is located in the `hibernate-orm-panache-kotlin-quickstart` {quickstarts-tree-url}/hibernate-orm-panache-kotlin-quickstart[directory].
The solution is located in the `hibernate-orm-panache-kotlin-quickstart` link:{quickstarts-tree-url}/hibernate-orm-panache-kotlin-quickstart[directory].


== Setting up and configuring Hibernate ORM with Panache and Kotlin
Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/asciidoc/hibernate-orm-panache.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ However, you can go right to the completed example.

Clone the Git repository: `git clone {quickstarts-clone-url}`, or download an {quickstarts-archive-url}[archive].

The solution is located in the `hibernate-orm-panache-quickstart` {quickstarts-tree-url}/hibernate-orm-panache-quickstart[directory].
The solution is located in the `hibernate-orm-panache-quickstart` link:{quickstarts-tree-url}/hibernate-orm-panache-quickstart[directory].

[NOTE]
====
Expand Down
Loading

0 comments on commit 66373fb

Please sign in to comment.