From d5f796d7f593b24789d035ac6032b519f3f37ea0 Mon Sep 17 00:00:00 2001 From: Paul Wright <5154224+pwright@users.noreply.github.com> Date: Tue, 3 Sep 2024 13:01:30 +0100 Subject: [PATCH] Update refs examples docs (#5105) * hard refs to old examples repo * soft references converted to versioned refs --- .../guide-exporting-registry-kafka-topic-data.adoc | 7 ++++--- .../getting-started/con-kafka-connect-converters.adoc | 2 +- .../partials/getting-started/con-registry-artifacts.adoc | 2 +- .../ROOT/partials/getting-started/con-registry-demo.adoc | 2 +- .../partials/getting-started/con-registry-serdes-avro.adoc | 4 ++-- .../partials/getting-started/con-registry-serdes-json.adoc | 4 ++-- .../getting-started/con-registry-serdes-protobuf.adoc | 4 ++-- .../getting-started/con-registry-serdes-types.adoc | 2 +- ...tifact-references-automatically-using-maven-plugin.adoc | 2 +- ...ng-artifact-references-manually-using-maven-plugin.adoc | 2 +- .../proc-adding-artifacts-using-maven-plugin.adoc | 2 +- .../proc-downloading-artifacts-using-maven-plugin.adoc | 2 +- .../proc-installing-registry-in-memory-storage.adoc | 2 +- .../proc-installing-registry-kafka-storage.adoc | 2 +- .../proc-installing-registry-sql-storage.adoc | 2 +- .../proc-migrating-registry-applications.adoc | 2 +- .../proc-testing-artifacts-using-maven-plugin.adoc | 2 +- .../getting-started/proc-writing-registry-client.adoc | 2 +- 18 files changed, 24 insertions(+), 23 deletions(-) diff --git a/docs/modules/ROOT/pages/getting-started/guide-exporting-registry-kafka-topic-data.adoc b/docs/modules/ROOT/pages/getting-started/guide-exporting-registry-kafka-topic-data.adoc index 8026d9fb5a..7154b57dec 100644 --- a/docs/modules/ROOT/pages/getting-started/guide-exporting-registry-kafka-topic-data.adoc +++ b/docs/modules/ROOT/pages/getting-started/guide-exporting-registry-kafka-topic-data.adoc @@ -140,12 +140,13 @@ After the topic export files have been created, you can run the following comman == Importing the kafkasql-journal topic data -To import `kafkasql-journal` topic data that has been created with `kcat`, use an https://github.com/Apicurio/apicurio-registry-examples/tree/main/tools/kafkasql-topic-import[application from the Apicurio Registry examples repository] as follows: +To import `kafkasql-journal` topic data that has been created with `kcat`, use an https://github.com/Apicurio/apicurio-registry/tree/{registry-version}.x/examples/tools/kafkasql-topic-import[application from the Apicurio Registry examples repository] as follows: [source,bash] ---- -git clone https://github.com/Apicurio/apicurio-registry-examples.git -cd apicurio-registry-examples/tools/kafkasql-topic-import +git clone https://github.com/Apicurio/apicurio-registry.git +git checkout {registry-version}.x +cd apicurio-registry/examples/tools/kafkasql-topic-import mvn clean install export VERSION=$(mvn help:evaluate -Dexpression=project.version -q -DforceStdout) java -jar target/apicurio-registry-tools-kafkasql-topic-import-$VERSION-jar-with-dependencies.jar -b -f diff --git a/docs/modules/ROOT/partials/getting-started/con-kafka-connect-converters.adoc b/docs/modules/ROOT/partials/getting-started/con-kafka-connect-converters.adoc index 79f4f4f437..444df9b34f 100644 --- a/docs/modules/ROOT/partials/getting-started/con-kafka-connect-converters.adoc +++ b/docs/modules/ROOT/partials/getting-started/con-kafka-connect-converters.adoc @@ -35,5 +35,5 @@ endif::[] ifdef::apicurio-registry[] * link:https://debezium.io/documentation/reference/stable/configuration/avro.html[Configuring Debezium to use Avro serialization and {registry}] endif::[] -* link:https://github.com/Apicurio/apicurio-registry-examples/tree/main/event-driven-architecture[Example of using Debezium to monitor the PostgreSQL database used by Apicurio Registry] +* link:https://github.com/Apicurio/apicurio-registry/tree/{registry-version}.x/examples/event-driven-architecture[Example of using Debezium to monitor the PostgreSQL database used by Apicurio Registry] * link:https://kafka.apache.org/documentation/#connect[Apache Kafka Connect documentation] \ No newline at end of file diff --git a/docs/modules/ROOT/partials/getting-started/con-registry-artifacts.adoc b/docs/modules/ROOT/partials/getting-started/con-registry-artifacts.adoc index 48f29e8f7f..3d90e77446 100644 --- a/docs/modules/ROOT/partials/getting-started/con-registry-artifacts.adoc +++ b/docs/modules/ROOT/partials/getting-started/con-registry-artifacts.adoc @@ -129,4 +129,4 @@ ifdef::rh-openshift-sr[] ** {base-url}{manage-api-url-registry}[Managing Service Registry data using the Core Registry API]. ** {base-url}{manage-maven-plugin-url-registry}[Managing schemas and APIs using the Service Registry Maven plug-in]. endif::[] -* For a Java example, see the https://github.com/Apicurio/apicurio-registry-examples/tree/main/serdes-with-references[Apicurio Registry SerDes with references demonstration]. +* For a Java example, see the https://github.com/Apicurio/apicurio-registry/tree/{registry-version}.x/examples/serdes-with-references[Apicurio Registry SerDes with references demonstration]. diff --git a/docs/modules/ROOT/partials/getting-started/con-registry-demo.adoc b/docs/modules/ROOT/partials/getting-started/con-registry-demo.adoc index 46461a65dc..0442b6e1d1 100644 --- a/docs/modules/ROOT/partials/getting-started/con-registry-demo.adoc +++ b/docs/modules/ROOT/partials/getting-started/con-registry-demo.adoc @@ -21,4 +21,4 @@ These applications demonstrate use cases such as the following examples: [role="_additional-resources"] .Additional resources -* For more details, see link:https://github.com/Apicurio/apicurio-registry-examples[] +* For more details, see link:https://github.com/Apicurio/apicurio-registry/tree/{registry-version}.x/examples/[] diff --git a/docs/modules/ROOT/partials/getting-started/con-registry-serdes-avro.adoc b/docs/modules/ROOT/partials/getting-started/con-registry-serdes-avro.adoc index 9e36bd4882..dfb0388109 100644 --- a/docs/modules/ROOT/partials/getting-started/con-registry-serdes-avro.adoc +++ b/docs/modules/ROOT/partials/getting-started/con-registry-serdes-avro.adoc @@ -121,5 +121,5 @@ When using these schemas with Avro SerDes, two artifacts are created in {registr * For more details on Avro configuration, see the link:https://github.com/Apicurio/apicurio-registry/blob/main/serdes/avro-serde/src/main/java/io/apicurio/registry/serde/avro/AvroKafkaSerdeConfig.java[AvroKafkaSerdeConfig Java class] * For Java example applications, see: -** link:https://github.com/Apicurio/apicurio-registry-examples[Simple Avro example] -** link:https://github.com/Apicurio/apicurio-registry-examples[SerDes with references example] +** link:https://github.com/Apicurio/apicurio-registry/tree/{registry-version}.x/examples/[Simple Avro example] +** link:https://github.com/Apicurio/apicurio-registry/tree/{registry-version}.x/examples/[SerDes with references example] diff --git a/docs/modules/ROOT/partials/getting-started/con-registry-serdes-json.adoc b/docs/modules/ROOT/partials/getting-started/con-registry-serdes-json.adoc index fe0b70d674..5d64152ae8 100644 --- a/docs/modules/ROOT/partials/getting-started/con-registry-serdes-json.adoc +++ b/docs/modules/ROOT/partials/getting-started/con-registry-serdes-json.adoc @@ -105,5 +105,5 @@ In this example, a given citizen has a city. In {registry}, a citizen artifact w .Additional resources * For more details, see the link:https://github.com/Apicurio/apicurio-registry/blob/main/serdes/jsonschema-serde/src/main/java/io/apicurio/registry/serde/jsonschema/JsonSchemaKafkaDeserializerConfig.java[JsonSchemaKafkaDeserializerConfig Java class] * For Java example applications, see: -** link:https://github.com/Apicurio/apicurio-registry-examples[Simple JSON Schema example] -** link:https://github.com/Apicurio/apicurio-registry-examples[SerDes with references example] +** link:https://github.com/Apicurio/apicurio-registry/tree/{registry-version}.x/examples/[Simple JSON Schema example] +** link:https://github.com/Apicurio/apicurio-registry/tree/{registry-version}.x/examples/[SerDes with references example] diff --git a/docs/modules/ROOT/partials/getting-started/con-registry-serdes-protobuf.adoc b/docs/modules/ROOT/partials/getting-started/con-registry-serdes-protobuf.adoc index 1f5d7f1657..ed65d971c7 100644 --- a/docs/modules/ROOT/partials/getting-started/con-registry-serdes-protobuf.adoc +++ b/docs/modules/ROOT/partials/getting-started/con-registry-serdes-protobuf.adoc @@ -105,5 +105,5 @@ In this example, two Protobuf artifacts are stored in {registry}, one for `Table [role="_additional-resources"] .Additional resources * For Java example applications, see: -** link:https://github.com/Apicurio/apicurio-registry-examples[Protobuf Bean and Protobuf Find Latest examples] -** link:https://github.com/Apicurio/apicurio-registry-examples[SerDes with references example] +** link:https://github.com/Apicurio/apicurio-registry/tree/{registry-version}.x/examples/[Protobuf Bean and Protobuf Find Latest examples] +** link:https://github.com/Apicurio/apicurio-registry/tree/{registry-version}.x/examples/[SerDes with references example] diff --git a/docs/modules/ROOT/partials/getting-started/con-registry-serdes-types.adoc b/docs/modules/ROOT/partials/getting-started/con-registry-serdes-types.adoc index 2c971f9fe9..a2bab68180 100644 --- a/docs/modules/ROOT/partials/getting-started/con-registry-serdes-types.adoc +++ b/docs/modules/ROOT/partials/getting-started/con-registry-serdes-types.adoc @@ -75,4 +75,4 @@ private static KafkaConsumer createKafkaConsumer() { [role="_additional-resources"] .Additional resources -* For an example application, see the link:https://github.com/Apicurio/apicurio-registry-examples[Simple Avro example] +* For an example application, see the link:https://github.com/Apicurio/apicurio-registry/tree/{registry-version}.x/examples/[Simple Avro example] diff --git a/docs/modules/ROOT/partials/getting-started/proc-adding-artifact-references-automatically-using-maven-plugin.adoc b/docs/modules/ROOT/partials/getting-started/proc-adding-artifact-references-automatically-using-maven-plugin.adoc index d136e716da..e263db0e62 100644 --- a/docs/modules/ROOT/partials/getting-started/proc-adding-artifact-references-automatically-using-maven-plugin.adoc +++ b/docs/modules/ROOT/partials/getting-started/proc-adding-artifact-references-automatically-using-maven-plugin.adoc @@ -121,7 +121,7 @@ endif::[] [role="_additional-resources"] .Additional resources * For more details on using Apache Maven, see the https://maven.apache.org/index.html[Apache Maven documentation]. - * For an open source example of using the {registry} Maven plug-in to automatically register multiple artifact references, see the link:https://github.com/Apicurio/apicurio-registry-examples/tree/main/avro-maven-with-references-auto[avro-maven-with-references-auto demonstration example]. + * For an open source example of using the {registry} Maven plug-in to automatically register multiple artifact references, see the link:https://github.com/Apicurio/apicurio-registry/tree/{registry-version}.x/examples/avro-maven-with-references-auto[avro-maven-with-references-auto demonstration example]. * For more examples of artifact references, see the section on configuring each artifact type in {registry-client-serdes-config}. diff --git a/docs/modules/ROOT/partials/getting-started/proc-adding-artifact-references-manually-using-maven-plugin.adoc b/docs/modules/ROOT/partials/getting-started/proc-adding-artifact-references-manually-using-maven-plugin.adoc index aa1e3d10c4..18a35d63ae 100644 --- a/docs/modules/ROOT/partials/getting-started/proc-adding-artifact-references-manually-using-maven-plugin.adoc +++ b/docs/modules/ROOT/partials/getting-started/proc-adding-artifact-references-manually-using-maven-plugin.adoc @@ -124,7 +124,7 @@ endif::[] [role="_additional-resources"] .Additional resources * For more details on using Apache Maven, see the https://maven.apache.org/index.html[Apache Maven documentation]. - * For an open source example of using the {registry} Maven plug-in to manually register an artifact reference, see the link:https://github.com/Apicurio/apicurio-registry-examples/tree/main/avro-maven-with-references[avro-maven-with-references demonstration example]. + * For an open source example of using the {registry} Maven plug-in to manually register an artifact reference, see the link:https://github.com/Apicurio/apicurio-registry/tree/{registry-version}.x/examples/avro-maven-with-references[avro-maven-with-references demonstration example]. * For more examples of artifact references, see the section on configuring each artifact type in {registry-client-serdes-config}. diff --git a/docs/modules/ROOT/partials/getting-started/proc-adding-artifacts-using-maven-plugin.adoc b/docs/modules/ROOT/partials/getting-started/proc-adding-artifacts-using-maven-plugin.adoc index 27e06d4b2d..620dd4d6a1 100644 --- a/docs/modules/ROOT/partials/getting-started/proc-adding-artifacts-using-maven-plugin.adoc +++ b/docs/modules/ROOT/partials/getting-started/proc-adding-artifacts-using-maven-plugin.adoc @@ -69,4 +69,4 @@ endif::[] [role="_additional-resources"] .Additional resources * For more details on using Apache Maven, see the https://maven.apache.org/index.html[Apache Maven documentation]. - * For open source examples of using the {registry} Maven plug-in, see the link:https://github.com/Apicurio/apicurio-registry-examples[Apicurio Registry demonstration examples]. + * For open source examples of using the {registry} Maven plug-in, see the link:https://github.com/Apicurio/apicurio-registry/tree/{registry-version}.x/examples/[Apicurio Registry demonstration examples]. diff --git a/docs/modules/ROOT/partials/getting-started/proc-downloading-artifacts-using-maven-plugin.adoc b/docs/modules/ROOT/partials/getting-started/proc-downloading-artifacts-using-maven-plugin.adoc index e4e29323c7..6213d8b278 100644 --- a/docs/modules/ROOT/partials/getting-started/proc-downloading-artifacts-using-maven-plugin.adoc +++ b/docs/modules/ROOT/partials/getting-started/proc-downloading-artifacts-using-maven-plugin.adoc @@ -68,4 +68,4 @@ endif::[] [role="_additional-resources"] .Additional resources * For more details on using Apache Maven, see the https://maven.apache.org/index.html[Apache Maven documentation]. - * For open source examples of using the {registry} Maven plug-in, see the link:https://github.com/Apicurio/apicurio-registry-examples[Apicurio Registry demonstration examples]. + * For open source examples of using the {registry} Maven plug-in, see the link:https://github.com/Apicurio/apicurio-registry/tree/{registry-version}.x/examples/[Apicurio Registry demonstration examples]. diff --git a/docs/modules/ROOT/partials/getting-started/proc-installing-registry-in-memory-storage.adoc b/docs/modules/ROOT/partials/getting-started/proc-installing-registry-in-memory-storage.adoc index 40fa86a7cf..fca518a0f8 100644 --- a/docs/modules/ROOT/partials/getting-started/proc-installing-registry-in-memory-storage.adoc +++ b/docs/modules/ROOT/partials/getting-started/proc-installing-registry-in-memory-storage.adoc @@ -49,4 +49,4 @@ $ curl -X POST -H "Content-type: application/json; artifactType=AVRO" -H "X-Regi [role="_additional-resources"] .Additional resources * For more REST API sample requests, see the link:{attachmentsdir}/registry-rest-api.htm[Apicurio Registry REST API documentation]. -* For demonstration examples, see link:https://github.com/Apicurio/apicurio-registry-examples[]. +* For demonstration examples, see link:https://github.com/Apicurio/apicurio-registry/tree/{registry-version}.x/examples/[]. diff --git a/docs/modules/ROOT/partials/getting-started/proc-installing-registry-kafka-storage.adoc b/docs/modules/ROOT/partials/getting-started/proc-installing-registry-kafka-storage.adoc index 54443483bb..df99bf79e7 100644 --- a/docs/modules/ROOT/partials/getting-started/proc-installing-registry-kafka-storage.adoc +++ b/docs/modules/ROOT/partials/getting-started/proc-installing-registry-kafka-storage.adoc @@ -94,5 +94,5 @@ $ curl -X POST -H "Content-type: application/json; artifactType=AVRO" -H "X-Regi [role="_additional-resources"] .Additional resources * For more REST API sample requests, see the link:{attachmentsdir}/registry-rest-api.htm[Apicurio Registry REST API documentation]. -* For demonstration examples, see link:https://github.com/Apicurio/apicurio-registry-examples[]. +* For demonstration examples, see link:https://github.com/Apicurio/apicurio-registry/tree/{registry-version}.x/examples/[]. * For more details on Apache Kafka, see https://kafka.apache.org/documentation/. diff --git a/docs/modules/ROOT/partials/getting-started/proc-installing-registry-sql-storage.adoc b/docs/modules/ROOT/partials/getting-started/proc-installing-registry-sql-storage.adoc index d59b108d62..d82378c861 100644 --- a/docs/modules/ROOT/partials/getting-started/proc-installing-registry-sql-storage.adoc +++ b/docs/modules/ROOT/partials/getting-started/proc-installing-registry-sql-storage.adoc @@ -57,5 +57,5 @@ $ curl -X POST -H "Content-type: application/json; artifactType=AVRO" -H "X-Regi [role="_additional-resources"] .Additional resources * For more REST API sample requests, see the link:{attachmentsdir}/registry-rest-api.htm[Apicurio Registry REST API documentation]. -* For demonstration examples, see link:https://github.com/Apicurio/apicurio-registry-examples[]. +* For demonstration examples, see link:https://github.com/Apicurio/apicurio-registry/tree/{registry-version}.x/examples/[]. * For more details on PostgreSQL, see the link:https://www.postgresql.org/docs/12/index.html[PostgreSQL documentation]. diff --git a/docs/modules/ROOT/partials/getting-started/proc-migrating-registry-applications.adoc b/docs/modules/ROOT/partials/getting-started/proc-migrating-registry-applications.adoc index bf4f5ebe47..eb202b04ed 100644 --- a/docs/modules/ROOT/partials/getting-started/proc-migrating-registry-applications.adoc +++ b/docs/modules/ROOT/partials/getting-started/proc-migrating-registry-applications.adoc @@ -105,4 +105,4 @@ endif::[] [role="_additional-resources"] .Additional resources -* For detailed configuration examples, see the link:https://github.com/Apicurio/apicurio-registry-examples[Apicurio Registry example applications]. +* For detailed configuration examples, see the link:https://github.com/Apicurio/apicurio-registry/tree/{registry-version}.x/examples/[Apicurio Registry example applications]. diff --git a/docs/modules/ROOT/partials/getting-started/proc-testing-artifacts-using-maven-plugin.adoc b/docs/modules/ROOT/partials/getting-started/proc-testing-artifacts-using-maven-plugin.adoc index 21db031d5e..d63095e767 100644 --- a/docs/modules/ROOT/partials/getting-started/proc-testing-artifacts-using-maven-plugin.adoc +++ b/docs/modules/ROOT/partials/getting-started/proc-testing-artifacts-using-maven-plugin.adoc @@ -63,4 +63,4 @@ endif::[] [role="_additional-resources"] .Additional resources * For more details on using Apache Maven, see the https://maven.apache.org/index.html[Apache Maven documentation]. - * For open source examples of using the {registry} Maven plug-in, see the link:https://github.com/Apicurio/apicurio-registry-examples[Apicurio Registry demonstration examples]. \ No newline at end of file + * For open source examples of using the {registry} Maven plug-in, see the link:https://github.com/Apicurio/apicurio-registry/tree/{registry-version}.x/examples/[Apicurio Registry demonstration examples]. \ No newline at end of file diff --git a/docs/modules/ROOT/partials/getting-started/proc-writing-registry-client.adoc b/docs/modules/ROOT/partials/getting-started/proc-writing-registry-client.adoc index c60d27c97b..3b42f6ffa0 100644 --- a/docs/modules/ROOT/partials/getting-started/proc-writing-registry-client.adoc +++ b/docs/modules/ROOT/partials/getting-started/proc-writing-registry-client.adoc @@ -49,6 +49,6 @@ When the client is created, you can use all of the operations available in the { [role="_additional-resources"] .Additional resources -* For an open source example of how to use and customize the {registry} client, see the https://github.com/Apicurio/apicurio-registry-examples[Apicurio Registry REST client demonstration]. +* For an open source example of how to use and customize the {registry} client, see the https://github.com/Apicurio/apicurio-registry/tree/{registry-version}.x/examples/[Apicurio Registry REST client demonstration]. * For details on how to use the {registry} Kafka client serializers/deserializers (SerDes) in producer and consumer applications, see {kafka-client-serdes}.