Skip to content

Commit 70561e8

Browse files
pwrightpwright
authored
change example references (#4714)
1 parent 51f953e commit 70561e8

19 files changed

+27
-23
lines changed

‎docs/modules/ROOT/pages/getting-started/guide-exporting-registry-kafka-topic-data.adoc

+6-3
Original file line numberDiff line numberDiff line change
@@ -140,12 +140,15 @@ After the topic export files have been created, you can run the following comman
140140

141141
== Importing the kafkasql-journal topic data
142142

143-
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:
143+
To import `kafkasql-journal` topic data that has been created with `kcat`, use an https://github.com/Apicurio/apicurio-registry/tree/{registry-branch}/examples/tools/kafkasql-topic-import[application from the Apicurio Registry examples repository] as follows:
144144

145+
[subs="attributes"]
145146
[source,bash]
146147
----
147-
git clone https://github.com/Apicurio/apicurio-registry-examples.git
148-
cd apicurio-registry-examples/tools/kafkasql-topic-import
148+
git clone https://github.com/Apicurio/apicurio-registry.git
149+
cd apicurio-registry
150+
git checkout {registry-branch}
151+
cd examples/tools/kafkasql-topic-import
149152
mvn clean install
150153
export VERSION=$(mvn help:evaluate -Dexpression=project.version -q -DforceStdout)
151154
java -jar target/apicurio-registry-tools-kafkasql-topic-import-$VERSION-jar-with-dependencies.jar -b <optional-kafka-bootstrap-server-url> -f <path-to-topic-dump-file>

‎docs/modules/ROOT/partials/getting-started/con-kafka-connect-converters.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -35,5 +35,5 @@ endif::[]
3535
ifdef::apicurio-registry[]
3636
* link:https://debezium.io/documentation/reference/stable/configuration/avro.html[Configuring Debezium to use Avro serialization and {registry}]
3737
endif::[]
38-
* 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]
38+
* link:https://github.com/Apicurio/apicurio-registry/tree/{registry-branch}/examples/event-driven-architecture[Example of using Debezium to monitor the PostgreSQL database used by Apicurio Registry]
3939
* link:https://kafka.apache.org/documentation/#connect[Apache Kafka Connect documentation]

‎docs/modules/ROOT/partials/getting-started/con-registry-artifacts.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -129,4 +129,4 @@ ifdef::rh-openshift-sr[]
129129
** {base-url}{manage-api-url-registry}[Managing Service Registry data using the Core Registry API].
130130
** {base-url}{manage-maven-plugin-url-registry}[Managing schemas and APIs using the Service Registry Maven plug-in].
131131
endif::[]
132-
* For a Java example, see the https://github.com/Apicurio/apicurio-registry-examples/tree/main/serdes-with-references[Apicurio Registry SerDes with references demonstration].
132+
* For a Java example, see the https://github.com/Apicurio/apicurio-registry/tree/{registry-branch}/examples/serdes-with-references[Apicurio Registry SerDes with references demonstration].

‎docs/modules/ROOT/partials/getting-started/con-registry-demo.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -21,4 +21,4 @@ These applications demonstrate use cases such as the following examples:
2121

2222
[role="_additional-resources"]
2323
.Additional resources
24-
* For more details, see link:https://github.com/Apicurio/apicurio-registry-examples[]
24+
* For more details, see link:https://github.com/Apicurio/apicurio-registry/tree/{registry-branch}/examples[]

‎docs/modules/ROOT/partials/getting-started/con-registry-serdes-avro.adoc

+2-2
Original file line numberDiff line numberDiff line change
@@ -121,5 +121,5 @@ When using these schemas with Avro SerDes, two artifacts are created in {registr
121121

122122
* 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]
123123
* For Java example applications, see:
124-
** link:https://github.com/Apicurio/apicurio-registry-examples[Simple Avro example]
125-
** link:https://github.com/Apicurio/apicurio-registry-examples[SerDes with references example]
124+
** link:https://github.com/Apicurio/apicurio-registry/tree/{registry-branch}/examples[Simple Avro example]
125+
** link:https://github.com/Apicurio/apicurio-registry/tree/{registry-branch}/examples[SerDes with references example]

‎docs/modules/ROOT/partials/getting-started/con-registry-serdes-json.adoc

+2-2
Original file line numberDiff line numberDiff line change
@@ -105,5 +105,5 @@ In this example, a given citizen has a city. In {registry}, a citizen artifact w
105105
.Additional resources
106106
* 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]
107107
* For Java example applications, see:
108-
** link:https://github.com/Apicurio/apicurio-registry-examples[Simple JSON Schema example]
109-
** link:https://github.com/Apicurio/apicurio-registry-examples[SerDes with references example]
108+
** link:https://github.com/Apicurio/apicurio-registry/tree/{registry-branch}/examples[Simple JSON Schema example]
109+
** link:https://github.com/Apicurio/apicurio-registry/tree/{registry-branch}/examples[SerDes with references example]

‎docs/modules/ROOT/partials/getting-started/con-registry-serdes-protobuf.adoc

+2-2
Original file line numberDiff line numberDiff line change
@@ -105,5 +105,5 @@ In this example, two Protobuf artifacts are stored in {registry}, one for `Table
105105
[role="_additional-resources"]
106106
.Additional resources
107107
* For Java example applications, see:
108-
** link:https://github.com/Apicurio/apicurio-registry-examples[Protobuf Bean and Protobuf Find Latest examples]
109-
** link:https://github.com/Apicurio/apicurio-registry-examples[SerDes with references example]
108+
** link:https://github.com/Apicurio/apicurio-registry/tree/{registry-branch}/examples[Protobuf Bean and Protobuf Find Latest examples]
109+
** link:https://github.com/Apicurio/apicurio-registry/tree/{registry-branch}/examples[SerDes with references example]

‎docs/modules/ROOT/partials/getting-started/con-registry-serdes-types.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -75,4 +75,4 @@ private static KafkaConsumer<Long, GenericRecord> createKafkaConsumer() {
7575

7676
[role="_additional-resources"]
7777
.Additional resources
78-
* For an example application, see the link:https://github.com/Apicurio/apicurio-registry-examples[Simple Avro example]
78+
* For an example application, see the link:https://github.com/Apicurio/apicurio-registry/tree/{registry-branch}/examples[Simple Avro example]

‎docs/modules/ROOT/partials/getting-started/proc-adding-artifact-references-automatically-using-maven-plugin.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ endif::[]
121121
[role="_additional-resources"]
122122
.Additional resources
123123
* For more details on using Apache Maven, see the https://maven.apache.org/index.html[Apache Maven documentation].
124-
* 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].
124+
* 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-branch}/examples/avro-maven-with-references-auto[avro-maven-with-references-auto demonstration example].
125125
* For more examples of artifact references, see the section on configuring each artifact type in {registry-client-serdes-config}.
126126

127127

‎docs/modules/ROOT/partials/getting-started/proc-adding-artifact-references-manually-using-maven-plugin.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,7 @@ endif::[]
124124
[role="_additional-resources"]
125125
.Additional resources
126126
* For more details on using Apache Maven, see the https://maven.apache.org/index.html[Apache Maven documentation].
127-
* 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].
127+
* 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-branch}/examples/avro-maven-with-references[avro-maven-with-references demonstration example].
128128
* For more examples of artifact references, see the section on configuring each artifact type in {registry-client-serdes-config}.
129129

130130

‎docs/modules/ROOT/partials/getting-started/proc-adding-artifacts-using-maven-plugin.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -69,4 +69,4 @@ endif::[]
6969
[role="_additional-resources"]
7070
.Additional resources
7171
* For more details on using Apache Maven, see the https://maven.apache.org/index.html[Apache Maven documentation].
72-
* 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].
72+
* For open source examples of using the {registry} Maven plug-in, see the link:https://github.com/Apicurio/apicurio-registry/tree/{registry-branch}/examples[Apicurio Registry demonstration examples].

‎docs/modules/ROOT/partials/getting-started/proc-downloading-artifacts-using-maven-plugin.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -68,4 +68,4 @@ endif::[]
6868
[role="_additional-resources"]
6969
.Additional resources
7070
* For more details on using Apache Maven, see the https://maven.apache.org/index.html[Apache Maven documentation].
71-
* 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].
71+
* For open source examples of using the {registry} Maven plug-in, see the link:https://github.com/Apicurio/apicurio-registry/tree/{registry-branch}/examples[Apicurio Registry demonstration examples].

‎docs/modules/ROOT/partials/getting-started/proc-installing-registry-in-memory-storage.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -49,4 +49,4 @@ $ curl -X POST -H "Content-type: application/json; artifactType=AVRO" -H "X-Regi
4949
[role="_additional-resources"]
5050
.Additional resources
5151
* For more REST API sample requests, see the link:{attachmentsdir}/registry-rest-api.htm[Apicurio Registry REST API documentation].
52-
* For demonstration examples, see link:https://github.com/Apicurio/apicurio-registry-examples[].
52+
* For demonstration examples, see link:https://github.com/Apicurio/apicurio-registry/tree/{registry-branch}/examples[].

‎docs/modules/ROOT/partials/getting-started/proc-installing-registry-kafka-storage.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -94,5 +94,5 @@ $ curl -X POST -H "Content-type: application/json; artifactType=AVRO" -H "X-Regi
9494
[role="_additional-resources"]
9595
.Additional resources
9696
* For more REST API sample requests, see the link:{attachmentsdir}/registry-rest-api.htm[Apicurio Registry REST API documentation].
97-
* For demonstration examples, see link:https://github.com/Apicurio/apicurio-registry-examples[].
97+
* For demonstration examples, see link:https://github.com/Apicurio/apicurio-registry/tree/{registry-branch}/examples[].
9898
* For more details on Apache Kafka, see https://kafka.apache.org/documentation/.

‎docs/modules/ROOT/partials/getting-started/proc-installing-registry-sql-storage.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -57,5 +57,5 @@ $ curl -X POST -H "Content-type: application/json; artifactType=AVRO" -H "X-Regi
5757
[role="_additional-resources"]
5858
.Additional resources
5959
* For more REST API sample requests, see the link:{attachmentsdir}/registry-rest-api.htm[Apicurio Registry REST API documentation].
60-
* For demonstration examples, see link:https://github.com/Apicurio/apicurio-registry-examples[].
60+
* For demonstration examples, see link:https://github.com/Apicurio/apicurio-registry/tree/{registry-branch}/examples[].
6161
* For more details on PostgreSQL, see the link:https://www.postgresql.org/docs/12/index.html[PostgreSQL documentation].

‎docs/modules/ROOT/partials/getting-started/proc-migrating-registry-applications.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -105,4 +105,4 @@ endif::[]
105105

106106
[role="_additional-resources"]
107107
.Additional resources
108-
* For detailed configuration examples, see the link:https://github.com/Apicurio/apicurio-registry-examples[Apicurio Registry example applications].
108+
* For detailed configuration examples, see the link:https://github.com/Apicurio/apicurio-registry/tree/{registry-branch}/examples[Apicurio Registry example applications].

‎docs/modules/ROOT/partials/getting-started/proc-testing-artifacts-using-maven-plugin.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -63,4 +63,4 @@ endif::[]
6363
[role="_additional-resources"]
6464
.Additional resources
6565
* For more details on using Apache Maven, see the https://maven.apache.org/index.html[Apache Maven documentation].
66-
* 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].
66+
* For open source examples of using the {registry} Maven plug-in, see the link:https://github.com/Apicurio/apicurio-registry/tree/{registry-branch}/examples[Apicurio Registry demonstration examples].

‎docs/modules/ROOT/partials/getting-started/proc-writing-registry-client.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,6 @@ When the client is created, you can use all of the operations available in the {
4949

5050
[role="_additional-resources"]
5151
.Additional resources
52-
* 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].
52+
* For an open source example of how to use and customize the {registry} client, see the https://github.com/Apicurio/apicurio-registry/tree/{registry-branch}/examples[Apicurio Registry REST client demonstration].
5353

5454
* For details on how to use the {registry} Kafka client serializers/deserializers (SerDes) in producer and consumer applications, see {kafka-client-serdes}.

‎docs/modules/ROOT/partials/shared/attributes.adoc

+1
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,7 @@ endif::[]
7373
:registry-ocp-version: 4.15
7474
:registry-db-version: 15
7575
:registry-url: \http://MY_REGISTRY_URL/ui
76+
:registry-branch: {registry-version}.x
7677

7778
//integration products
7879
:amq-version: 2.6

0 commit comments

Comments
 (0)