Automated Publishing of Documentation for Apicurio Registry

Apicurio · Nov 4, 2024 · e2fc39e · e2fc39e
1 parent 6954e06
commit e2fc39e
Show file tree

Hide file tree

Showing 6 changed files with 237 additions and 194 deletions.
diff --git a/.../assets-images/images/getting-started/registry-web-console-artifact-version.png b/.../assets-images/images/getting-started/registry-web-console-artifact-version.png
diff --git a/...ry/3.0.x/assets-images/images/getting-started/registry-web-console-artifact.png b/...ry/3.0.x/assets-images/images/getting-started/registry-web-console-artifact.png
diff --git a/...docs/apicurio-registry/3.0.x/getting-started/assembly-managing-registry-artifacts-ui.html b/...docs/apicurio-registry/3.0.x/getting-started/assembly-managing-registry-artifacts-ui.html
@@ -507,29 +507,62 @@ <h2 id="adding-artifacts-using-console_registry"><a class="anchor" href="#adding
 <div class="title">Procedure</div>
 <ol class="arabic">
 <li>
-<p>On the <strong>Explore</strong> tab, click <strong>Create artifact</strong>, and specify the following details:</p>
+<p>On the <strong>Explore</strong> tab, click <strong>Create artifact</strong>, and complete the <strong>Create artifact</strong> wizard:</p>
+<div class="admonitionblock note">
+<table>
+<tr>
+<td class="icon">
+<i class="fa icon-note" title="Note"></i>
+</td>
+<td class="content">
+<div class="paragraph">
+<p>You can create a placeholder artifact without content, but you must specify the artifact type, as Apicurio Registry cannot automatically detect the content type.
+Creating a placeholder allows you create rules first and add content later.</p>
+</div>
+</td>
+</tr>
+</table>
+</div>
+<div class="olist loweralpha">
+<ol class="loweralpha" type="a">
+<li>
+<p>Specify the <strong>Artifact Coordinates</strong> and click <strong>Next</strong>:</p>
 <div class="ulist">
 <ul>
 <li>
-<p><strong>Artifact Coordinates</strong> / <strong>Group ID &amp; Artifact ID</strong>: Use the default empty settings to automatically generate an artifact ID and add the artifact to the <code>default</code> artifact group. Alternatively, you can enter an optional artifact group or artifact ID.</p>
+<p><strong>Group ID &amp; Artifact ID</strong>: Use the default empty settings to automatically generate an artifact ID and add the artifact to the <code>default</code> artifact group. Alternatively, you can enter an optional artifact group or artifact ID.</p>
 </li>
 <li>
-<p><strong>Artifact Coordinates</strong> / <strong>Type</strong>: Use the default <strong>Auto-Detect</strong> setting to automatically detect the artifact type (not allowed if creating an empty artifact), or select the artifact type from the list, for example, <strong>Avro Schema</strong> or <strong>OpenAPI</strong>. You must manually select the <strong>Kafka Connect Schema</strong> artifact type, which cannot be automatically detected.</p>
+<p><strong>Type</strong>: Use the default <strong>Auto-Detect</strong> setting to automatically detect the artifact type (not allowed if creating an empty artifact), or select the artifact type from the list, for example, <strong>Avro Schema</strong> or <strong>OpenAPI</strong>. You must manually select the <strong>Kafka Connect Schema</strong> artifact type, which cannot be automatically detected.</p>
+</li>
+</ul>
+</div>
 </li>
 <li>
-<p><strong>Artifact Metadata</strong> / <strong>Name</strong>: Enter an optional friendly name for the new artifact.</p>
+<p>Specify the <strong>Artifact Metadata</strong> and click <strong>Next</strong>:</p>
+<div class="ulist">
+<ul>
+<li>
+<p><strong>Name</strong>: Enter an optional friendly name for the new artifact.</p>
 </li>
 <li>
-<p><strong>Artifact Metadata</strong> / <strong>Description</strong>: Enter an optional description for the new artifact.</p>
+<p><strong>Description</strong>: Enter an optional description for the new artifact.</p>
 </li>
 <li>
-<p><strong>Artifact Metadata</strong> / <strong>Labels</strong>: Optionally add one or more label (name/value pair) for the new artifact.</p>
+<p><strong>Labels</strong>: Optionally add one or more label (name/value pair) for the new artifact.</p>
+</li>
+</ul>
+</div>
 </li>
 <li>
-<p><strong>Version Content</strong> / <strong>Version Number</strong>: Optionally add a version string if creating a first version.</p>
+<p>Specify the <strong>Version Content</strong> and click <strong>Next</strong>:</p>
+<div class="ulist">
+<ul>
+<li>
+<p><strong>Version Number</strong>: Optionally add a version string if creating a first version.</p>
 </li>
 <li>
-<p><strong>Version Content</strong> / <strong>Content</strong>: Specify the content using either of the following options:</p>
+<p><strong>Content</strong>: Specify the content using either of the following options:</p>
 <div class="ulist">
 <ul>
 <li>
@@ -541,18 +574,28 @@ <h2 id="adding-artifacts-using-console_registry"><a class="anchor" href="#adding
 </ul>
 </div>
 </li>
+</ul>
+</div>
+</li>
 <li>
-<p><strong>Version Metadata</strong> / <strong>Name</strong>: Enter an optional friendly name for the first artifact version.</p>
+<p>Specify the <strong>Version Metadata</strong>:</p>
+<div class="ulist">
+<ul>
+<li>
+<p><strong>Name</strong>: Enter an optional friendly name for the first artifact version.</p>
 </li>
 <li>
-<p><strong>Version Metadata</strong> / <strong>Description</strong>: Enter an optional description for the first artifact version.</p>
+<p><strong>Description</strong>: Enter an optional description for the first artifact version.</p>
 </li>
 <li>
-<p><strong>Version Metadata</strong> / <strong>Labels</strong>: Optionally add one or more label (name/value pair) for the first artifact version.</p>
+<p><strong>Labels</strong>: Optionally add one or more label (name/value pair) for the first artifact version.</p>
 </li>
 </ul>
 </div>
 </li>
+</ol>
+</div>
+</li>
 <li>
 <p>Click <strong>Create</strong> and view the artifact details:</p>
 <div class="ulist">

diff --git a/registry/docs/search-index.js b/registry/docs/search-index.js
diff --git a/registry/docs/sitemap-apicurio-registry-operator.xml b/registry/docs/sitemap-apicurio-registry-operator.xml
@@ -2,126 +2,126 @@
 <urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
 <url>
 <loc>https://www.apicur.io/registry/docs/apicurio-registry-operator/1.2.0-dev-v2.6.x/assembly-operator-configuration.html</loc>
-<lastmod>2024-10-29T17:06:12.590Z</lastmod>
+<lastmod>2024-11-04T16:15:42.744Z</lastmod>
 </url>
 <url>
 <loc>https://www.apicur.io/registry/docs/apicurio-registry-operator/1.2.0-dev-v2.6.x/assembly-operator-installation.html</loc>
-<lastmod>2024-10-29T17:06:12.590Z</lastmod>
+<lastmod>2024-11-04T16:15:42.744Z</lastmod>
 </url>
 <url>
 <loc>https://www.apicur.io/registry/docs/apicurio-registry-operator/1.2.0-dev-v2.6.x/assembly-operator-quickstart.html</loc>
-<lastmod>2024-10-29T17:06:12.590Z</lastmod>
+<lastmod>2024-11-04T16:15:42.744Z</lastmod>
 </url>
 <url>
 <loc>https://www.apicur.io/registry/docs/apicurio-registry-operator/1.2.0-dev-v2.6.x/assembly-registry-maintenance.html</loc>
-<lastmod>2024-10-29T17:06:12.590Z</lastmod>
+<lastmod>2024-11-04T16:15:42.744Z</lastmod>
 </url>
 <url>
 <loc>https://www.apicur.io/registry/docs/apicurio-registry-operator/1.2.0-dev-v2.6.x/assembly-registry-storage.html</loc>
-<lastmod>2024-10-29T17:06:12.590Z</lastmod>
+<lastmod>2024-11-04T16:15:42.744Z</lastmod>
 </url>
 <url>
 <loc>https://www.apicur.io/registry/docs/apicurio-registry-operator/1.2.0-dev-v2.6.x/index.html</loc>
-<lastmod>2024-10-29T17:06:12.590Z</lastmod>
+<lastmod>2024-11-04T16:15:42.744Z</lastmod>
 </url>
 <url>
 <loc>https://www.apicur.io/registry/docs/apicurio-registry-operator/1.1.1-v2.5.9.final/assembly-operator-configuration.html</loc>
-<lastmod>2024-10-29T17:06:12.590Z</lastmod>
+<lastmod>2024-11-04T16:15:42.744Z</lastmod>
 </url>
 <url>
 <loc>https://www.apicur.io/registry/docs/apicurio-registry-operator/1.1.1-v2.5.9.final/assembly-operator-installation.html</loc>
-<lastmod>2024-10-29T17:06:12.590Z</lastmod>
+<lastmod>2024-11-04T16:15:42.744Z</lastmod>
 </url>
 <url>
 <loc>https://www.apicur.io/registry/docs/apicurio-registry-operator/1.1.1-v2.5.9.final/assembly-operator-quickstart.html</loc>
-<lastmod>2024-10-29T17:06:12.590Z</lastmod>
+<lastmod>2024-11-04T16:15:42.744Z</lastmod>
 </url>
 <url>
 <loc>https://www.apicur.io/registry/docs/apicurio-registry-operator/1.1.1-v2.5.9.final/assembly-registry-maintenance.html</loc>
-<lastmod>2024-10-29T17:06:12.590Z</lastmod>
+<lastmod>2024-11-04T16:15:42.744Z</lastmod>
 </url>
 <url>
 <loc>https://www.apicur.io/registry/docs/apicurio-registry-operator/1.1.1-v2.5.9.final/assembly-registry-storage.html</loc>
-<lastmod>2024-10-29T17:06:12.590Z</lastmod>
+<lastmod>2024-11-04T16:15:42.744Z</lastmod>
 </url>
 <url>
 <loc>https://www.apicur.io/registry/docs/apicurio-registry-operator/1.1.1-v2.5.9.final/index.html</loc>
-<lastmod>2024-10-29T17:06:12.590Z</lastmod>
+<lastmod>2024-11-04T16:15:42.744Z</lastmod>
 </url>
 <url>
 <loc>https://www.apicur.io/registry/docs/apicurio-registry-operator/1.1.0-v2.4.12.final/assembly-operator-configuration.html</loc>
-<lastmod>2024-10-29T17:06:12.590Z</lastmod>
+<lastmod>2024-11-04T16:15:42.744Z</lastmod>
 </url>
 <url>
 <loc>https://www.apicur.io/registry/docs/apicurio-registry-operator/1.1.0-v2.4.12.final/assembly-operator-installation.html</loc>
-<lastmod>2024-10-29T17:06:12.590Z</lastmod>
+<lastmod>2024-11-04T16:15:42.744Z</lastmod>
 </url>
 <url>
 <loc>https://www.apicur.io/registry/docs/apicurio-registry-operator/1.1.0-v2.4.12.final/assembly-operator-quickstart.html</loc>
-<lastmod>2024-10-29T17:06:12.590Z</lastmod>
+<lastmod>2024-11-04T16:15:42.744Z</lastmod>
 </url>
 <url>
 <loc>https://www.apicur.io/registry/docs/apicurio-registry-operator/1.1.0-v2.4.12.final/assembly-registry-maintenance.html</loc>
-<lastmod>2024-10-29T17:06:12.590Z</lastmod>
+<lastmod>2024-11-04T16:15:42.744Z</lastmod>
 </url>
 <url>
 <loc>https://www.apicur.io/registry/docs/apicurio-registry-operator/1.1.0-v2.4.12.final/assembly-registry-storage.html</loc>
-<lastmod>2024-10-29T17:06:12.590Z</lastmod>
+<lastmod>2024-11-04T16:15:42.744Z</lastmod>
 </url>
 <url>
 <loc>https://www.apicur.io/registry/docs/apicurio-registry-operator/1.1.0-v2.4.12.final/index.html</loc>
-<lastmod>2024-10-29T17:06:12.590Z</lastmod>
+<lastmod>2024-11-04T16:15:42.744Z</lastmod>
 </url>
 <url>
 <loc>https://www.apicur.io/registry/docs/apicurio-registry-operator/1.0.0/assembly-operator-configuration.html</loc>
-<lastmod>2024-10-29T17:06:12.590Z</lastmod>
+<lastmod>2024-11-04T16:15:42.744Z</lastmod>
 </url>
 <url>
 <loc>https://www.apicur.io/registry/docs/apicurio-registry-operator/1.0.0/assembly-operator-installation.html</loc>
-<lastmod>2024-10-29T17:06:12.590Z</lastmod>
+<lastmod>2024-11-04T16:15:42.744Z</lastmod>
 </url>
 <url>
 <loc>https://www.apicur.io/registry/docs/apicurio-registry-operator/1.0.0/assembly-operator-quickstart.html</loc>
-<lastmod>2024-10-29T17:06:12.590Z</lastmod>
+<lastmod>2024-11-04T16:15:42.744Z</lastmod>
 </url>
 <url>
 <loc>https://www.apicur.io/registry/docs/apicurio-registry-operator/1.0.0/assembly-registry-maintenance.html</loc>
-<lastmod>2024-10-29T17:06:12.590Z</lastmod>
+<lastmod>2024-11-04T16:15:42.744Z</lastmod>
 </url>
 <url>
 <loc>https://www.apicur.io/registry/docs/apicurio-registry-operator/1.0.0/assembly-registry-storage.html</loc>
-<lastmod>2024-10-29T17:06:12.590Z</lastmod>
+<lastmod>2024-11-04T16:15:42.744Z</lastmod>
 </url>
 <url>
 <loc>https://www.apicur.io/registry/docs/apicurio-registry-operator/1.0.0/index.html</loc>
-<lastmod>2024-10-29T17:06:12.590Z</lastmod>
+<lastmod>2024-11-04T16:15:42.744Z</lastmod>
 </url>
 <url>
 <loc>https://www.apicur.io/registry/docs/apicurio-registry-operator/0.0.4/assembly-operator-configuration.html</loc>
-<lastmod>2024-10-29T17:06:12.590Z</lastmod>
+<lastmod>2024-11-04T16:15:42.744Z</lastmod>
 </url>
 <url>
 <loc>https://www.apicur.io/registry/docs/apicurio-registry-operator/0.0.4/assembly-operator-dev-quickstart-minikube.html</loc>
-<lastmod>2024-10-29T17:06:12.590Z</lastmod>
+<lastmod>2024-11-04T16:15:42.744Z</lastmod>
 </url>
 <url>
 <loc>https://www.apicur.io/registry/docs/apicurio-registry-operator/0.0.4/assembly-operator-installation.html</loc>
-<lastmod>2024-10-29T17:06:12.590Z</lastmod>
+<lastmod>2024-11-04T16:15:42.744Z</lastmod>
 </url>
 <url>
 <loc>https://www.apicur.io/registry/docs/apicurio-registry-operator/0.0.4/assembly-operator-quickstart.html</loc>
-<lastmod>2024-10-29T17:06:12.590Z</lastmod>
+<lastmod>2024-11-04T16:15:42.744Z</lastmod>
 </url>
 <url>
 <loc>https://www.apicur.io/registry/docs/apicurio-registry-operator/0.0.4/assembly-registry-maintenance.html</loc>
-<lastmod>2024-10-29T17:06:12.590Z</lastmod>
+<lastmod>2024-11-04T16:15:42.744Z</lastmod>
 </url>
 <url>
 <loc>https://www.apicur.io/registry/docs/apicurio-registry-operator/0.0.4/assembly-registry-storage.html</loc>
-<lastmod>2024-10-29T17:06:12.590Z</lastmod>
+<lastmod>2024-11-04T16:15:42.744Z</lastmod>
 </url>
 <url>
 <loc>https://www.apicur.io/registry/docs/apicurio-registry-operator/0.0.4/index.html</loc>
-<lastmod>2024-10-29T17:06:12.590Z</lastmod>
+<lastmod>2024-11-04T16:15:42.744Z</lastmod>
 </url>
 </urlset>