Skip to content

Commit

Permalink
Automated Publishing of Documentation for Apicurio Registry
Browse files Browse the repository at this point in the history
  • Loading branch information
apicurio-ci committed May 29, 2024
1 parent cf15ff5 commit cff5023
Show file tree
Hide file tree
Showing 10 changed files with 170 additions and 168 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -898,7 +898,7 @@ <h3 id="_kafka_application_configuration_for_serializersdeserializers" class="di
<div class="title">Additional resources</div>
<ul>
<li>
<p>For an example application, see the <a href="https://github.com/Apicurio/apicurio-registry-examples">Simple Avro example</a></p>
<p>For an example application, see the <a href="https://github.com/Apicurio/apicurio-registry/tree/2.5.x/examples">Simple Avro example</a></p>
</li>
</ul>
</div>
Expand Down Expand Up @@ -1117,10 +1117,10 @@ <h3 id="registry-serdes-types-avro_registry"><a class="anchor" href="#registry-s
<div class="ulist">
<ul>
<li>
<p><a href="https://github.com/Apicurio/apicurio-registry-examples">Simple Avro example</a></p>
<p><a href="https://github.com/Apicurio/apicurio-registry/tree/2.5.x/examples">Simple Avro example</a></p>
</li>
<li>
<p><a href="https://github.com/Apicurio/apicurio-registry-examples">SerDes with references example</a></p>
<p><a href="https://github.com/Apicurio/apicurio-registry/tree/2.5.x/examples">SerDes with references example</a></p>
</li>
</ul>
</div>
Expand Down Expand Up @@ -1282,10 +1282,10 @@ <h3 id="registry-serdes-types-json_registry"><a class="anchor" href="#registry-s
<div class="ulist">
<ul>
<li>
<p><a href="https://github.com/Apicurio/apicurio-registry-examples">Simple JSON Schema example</a></p>
<p><a href="https://github.com/Apicurio/apicurio-registry/tree/2.5.x/examples">Simple JSON Schema example</a></p>
</li>
<li>
<p><a href="https://github.com/Apicurio/apicurio-registry-examples">SerDes with references example</a></p>
<p><a href="https://github.com/Apicurio/apicurio-registry/tree/2.5.x/examples">SerDes with references example</a></p>
</li>
</ul>
</div>
Expand Down Expand Up @@ -1467,10 +1467,10 @@ <h3 id="registry-serdes-types-protobuf_registry"><a class="anchor" href="#regist
<div class="ulist">
<ul>
<li>
<p><a href="https://github.com/Apicurio/apicurio-registry-examples">Protobuf Bean and Protobuf Find Latest examples</a></p>
<p><a href="https://github.com/Apicurio/apicurio-registry/tree/2.5.x/examples">Protobuf Bean and Protobuf Find Latest examples</a></p>
</li>
<li>
<p><a href="https://github.com/Apicurio/apicurio-registry-examples">SerDes with references example</a></p>
<p><a href="https://github.com/Apicurio/apicurio-registry/tree/2.5.x/examples">SerDes with references example</a></p>
</li>
</ul>
</div>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -389,7 +389,7 @@ <h2 id="installing-registry-in-memory-storage_registry"><a class="anchor" href="
<p>For more REST API sample requests, see the <a href="../assets-attachments/registry-rest-api.htm">Apicurio Registry REST API documentation</a>.</p>
</li>
<li>
<p>For demonstration examples, see <a href="https://github.com/Apicurio/apicurio-registry-examples" class="bare">https://github.com/Apicurio/apicurio-registry-examples</a>.</p>
<p>For demonstration examples, see <a href="https://github.com/Apicurio/apicurio-registry/tree/2.5.x/examples" class="bare">https://github.com/Apicurio/apicurio-registry/tree/2.5.x/examples</a>.</p>
</li>
</ul>
</div>
Expand Down Expand Up @@ -474,7 +474,7 @@ <h2 id="installing-registry-sql-storage_registry"><a class="anchor" href="#insta
<p>For more REST API sample requests, see the <a href="../assets-attachments/registry-rest-api.htm">Apicurio Registry REST API documentation</a>.</p>
</li>
<li>
<p>For demonstration examples, see <a href="https://github.com/Apicurio/apicurio-registry-examples" class="bare">https://github.com/Apicurio/apicurio-registry-examples</a>.</p>
<p>For demonstration examples, see <a href="https://github.com/Apicurio/apicurio-registry/tree/2.5.x/examples" class="bare">https://github.com/Apicurio/apicurio-registry/tree/2.5.x/examples</a>.</p>
</li>
<li>
<p>For more details on PostgreSQL, see the <a href="https://www.postgresql.org/docs/12/index.html">PostgreSQL documentation</a>.</p>
Expand Down Expand Up @@ -572,7 +572,7 @@ <h2 id="installing-registry-kafka-storage_registry"><a class="anchor" href="#ins
<p>For more REST API sample requests, see the <a href="../assets-attachments/registry-rest-api.htm">Apicurio Registry REST API documentation</a>.</p>
</li>
<li>
<p>For demonstration examples, see <a href="https://github.com/Apicurio/apicurio-registry-examples" class="bare">https://github.com/Apicurio/apicurio-registry-examples</a>.</p>
<p>For demonstration examples, see <a href="https://github.com/Apicurio/apicurio-registry/tree/2.5.x/examples" class="bare">https://github.com/Apicurio/apicurio-registry/tree/2.5.x/examples</a>.</p>
</li>
<li>
<p>For more details on Apache Kafka, see <a href="https://kafka.apache.org/documentation/" class="bare">https://kafka.apache.org/documentation/</a>.</p>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -535,7 +535,7 @@ <h4 id="_supported_artifact_types" class="discrete">Supported artifact types</h4
</div>
</li>
<li>
<p>For a Java example, see the <a href="https://github.com/Apicurio/apicurio-registry-examples/tree/main/serdes-with-references">Apicurio Registry SerDes with references demonstration</a>.</p>
<p>For a Java example, see the <a href="https://github.com/Apicurio/apicurio-registry/tree/2.5.x/examples/serdes-with-references">Apicurio Registry SerDes with references demonstration</a>.</p>
</li>
</ul>
</div>
Expand Down Expand Up @@ -792,7 +792,7 @@ <h2 id="kafka-connect_registry"><a class="anchor" href="#kafka-connect_registry"
<p><a href="https://debezium.io/documentation/reference/stable/configuration/avro.html">Configuring Debezium to use Avro serialization and Apicurio Registry</a></p>
</li>
<li>
<p><a href="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</a></p>
<p><a href="https://github.com/Apicurio/apicurio-registry/tree/2.5.x/examples/event-driven-architecture">Example of using Debezium to monitor the PostgreSQL database used by Apicurio Registry</a></p>
</li>
<li>
<p><a href="https://kafka.apache.org/documentation/#connect">Apache Kafka Connect documentation</a></p>
Expand Down Expand Up @@ -848,7 +848,7 @@ <h2 id="registry-demo_registry"><a class="anchor" href="#registry-demo_registry"
<div class="title">Additional resources</div>
<ul>
<li>
<p>For more details, see <a href="https://github.com/Apicurio/apicurio-registry-examples" class="bare">https://github.com/Apicurio/apicurio-registry-examples</a></p>
<p>For more details, see <a href="https://github.com/Apicurio/apicurio-registry/tree/2.5.x/examples" class="bare">https://github.com/Apicurio/apicurio-registry/tree/2.5.x/examples</a></p>
</li>
</ul>
</div>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -398,7 +398,7 @@ <h2 id="adding-artifacts-using-maven-plugin_registry"><a class="anchor" href="#a
<p>For more details on using Apache Maven, see the <a href="https://maven.apache.org/index.html">Apache Maven documentation</a>.</p>
</li>
<li>
<p>For open source examples of using the Apicurio Registry Maven plug-in, see the <a href="https://github.com/Apicurio/apicurio-registry-examples">Apicurio Registry demonstration examples</a>.</p>
<p>For open source examples of using the Apicurio Registry Maven plug-in, see the <a href="https://github.com/Apicurio/apicurio-registry/tree/2.5.x/examples">Apicurio Registry demonstration examples</a>.</p>
</li>
</ul>
</div>
Expand Down Expand Up @@ -499,7 +499,7 @@ <h2 id="downloading-artifacts-using-maven-plugin_registry"><a class="anchor" hre
<p>For more details on using Apache Maven, see the <a href="https://maven.apache.org/index.html">Apache Maven documentation</a>.</p>
</li>
<li>
<p>For open source examples of using the Apicurio Registry Maven plug-in, see the <a href="https://github.com/Apicurio/apicurio-registry-examples">Apicurio Registry demonstration examples</a>.</p>
<p>For open source examples of using the Apicurio Registry Maven plug-in, see the <a href="https://github.com/Apicurio/apicurio-registry/tree/2.5.x/examples">Apicurio Registry demonstration examples</a>.</p>
</li>
</ul>
</div>
Expand Down Expand Up @@ -604,7 +604,7 @@ <h2 id="testing-artifacts-using-maven-plugin_registry"><a class="anchor" href="#
<p>For more details on using Apache Maven, see the <a href="https://maven.apache.org/index.html">Apache Maven documentation</a>.</p>
</li>
<li>
<p>For open source examples of using the Apicurio Registry Maven plug-in, see the <a href="https://github.com/Apicurio/apicurio-registry-examples">Apicurio Registry demonstration examples</a>.</p>
<p>For open source examples of using the Apicurio Registry Maven plug-in, see the <a href="https://github.com/Apicurio/apicurio-registry/tree/2.5.x/examples">Apicurio Registry demonstration examples</a>.</p>
</li>
</ul>
</div>
Expand Down Expand Up @@ -779,7 +779,7 @@ <h2 id="adding-artifact-references-manually-using-maven-plugin_registry"><a clas
<p>For more details on using Apache Maven, see the <a href="https://maven.apache.org/index.html">Apache Maven documentation</a>.</p>
</li>
<li>
<p>For an open source example of using the Apicurio Registry Maven plug-in to manually register an artifact reference, see the <a href="https://github.com/Apicurio/apicurio-registry-examples/tree/main/avro-maven-with-references">avro-maven-with-references demonstration example</a>.</p>
<p>For an open source example of using the Apicurio Registry Maven plug-in to manually register an artifact reference, see the <a href="https://github.com/Apicurio/apicurio-registry/tree/2.5.x/examples/avro-maven-with-references">avro-maven-with-references demonstration example</a>.</p>
</li>
<li>
<p>For more examples of artifact references, see the section on configuring each artifact type in <a href="assembly-configuring-kafka-client-serdes.html">Configuring Kafka serializers/deserializers in Java clients</a>.</p>
Expand Down Expand Up @@ -967,7 +967,7 @@ <h2 id="adding-artifact-references-automatically-using-maven-plugin_registry"><a
<p>For more details on using Apache Maven, see the <a href="https://maven.apache.org/index.html">Apache Maven documentation</a>.</p>
</li>
<li>
<p>For an open source example of using the Apicurio Registry Maven plug-in to automatically register multiple artifact references, see the <a href="https://github.com/Apicurio/apicurio-registry-examples/tree/main/avro-maven-with-references-auto">avro-maven-with-references-auto demonstration example</a>.</p>
<p>For an open source example of using the Apicurio Registry Maven plug-in to automatically register multiple artifact references, see the <a href="https://github.com/Apicurio/apicurio-registry/tree/2.5.x/examples/avro-maven-with-references-auto">avro-maven-with-references-auto demonstration example</a>.</p>
</li>
<li>
<p>For more examples of artifact references, see the section on configuring each artifact type in <a href="assembly-configuring-kafka-client-serdes.html">Configuring Kafka serializers/deserializers in Java clients</a>.</p>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -525,7 +525,7 @@ <h2 id="migrating-registry-applications_registry"><a class="anchor" href="#migra
<div class="title">Additional resources</div>
<ul>
<li>
<p>For detailed configuration examples, see the <a href="https://github.com/Apicurio/apicurio-registry-examples">Apicurio Registry example applications</a>.</p>
<p>For detailed configuration examples, see the <a href="https://github.com/Apicurio/apicurio-registry/tree/2.5.x/examples">Apicurio Registry example applications</a>.</p>
</li>
</ul>
</div>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -369,7 +369,7 @@ <h2 id="writing-registry-client_registry"><a class="anchor" href="#writing-regis
<div class="title">Additional resources</div>
<ul>
<li>
<p>For an open source example of how to use and customize the Apicurio Registry client, see the <a href="https://github.com/Apicurio/apicurio-registry-examples">Apicurio Registry REST client demonstration</a>.</p>
<p>For an open source example of how to use and customize the Apicurio Registry client, see the <a href="https://github.com/Apicurio/apicurio-registry/tree/2.5.x/examples">Apicurio Registry REST client demonstration</a>.</p>
</li>
<li>
<p>For details on how to use the Apicurio Registry Kafka client serializers/deserializers (SerDes) in producer and consumer applications, see <a href="assembly-using-kafka-client-serdes.html">Validating schemas using Kafka client serializers/deserializers in Java clients</a>.</p>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -456,15 +456,17 @@ <h2 id="_copy_topic_export_files_from_the_work_pod"><a class="anchor" href="#_co
<h2 id="_importing_the_kafkasql_journal_topic_data"><a class="anchor" href="#_importing_the_kafkasql_journal_topic_data"></a>Importing the kafkasql-journal topic data</h2>
<div class="sectionbody">
<div class="paragraph">
<p>To import <code>kafkasql-journal</code> topic data that has been created with <code>kcat</code>, use an <a href="https://github.com/Apicurio/apicurio-registry-examples/tree/main/tools/kafkasql-topic-import">application from the Apicurio Registry examples repository</a> as follows:</p>
<p>To import <code>kafkasql-journal</code> topic data that has been created with <code>kcat</code>, use an <a href="https://github.com/Apicurio/apicurio-registry/tree/2.5.x/examples/tools/kafkasql-topic-import">application from the Apicurio Registry examples repository</a> as follows:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">git clone https://github.com/Apicurio/apicurio-registry-examples.git
cd apicurio-registry-examples/tools/kafkasql-topic-import
<pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">git clone https://github.com/Apicurio/apicurio-registry.git
cd apicurio-registry
git checkout 2.5.x
cd 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 &lt;optional-kafka-bootstrap-server-url&gt; -f &lt;path-to-topic-dump-file&gt;</code></pre>
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></code></pre>
</div>
</div>
<div class="ulist _additional-resources">
Expand Down
2 changes: 1 addition & 1 deletion registry/docs/search-index.js

Large diffs are not rendered by default.

Loading

0 comments on commit cff5023

Please sign in to comment.