Added some documentation about configuring the registry UI (#946)

* Added some documentation about configuring the registry UI

* renamed user interface to web console

* address feedback

docs/local-test-playbook.yml

@@ -14,6 +14,12 @@ ui:
     url: https://raw.githubusercontent.com/Apicurio/apicurio-docs-ui/master/dist/ui-bundle.zip
     snapshot: true
 
+runtime:
+  cache_dir: ./target/antora-cache
+
+output:
+  dir: ./target/dist
+
 asciidoc:
   attributes:
     plantuml-server-url: 'http://www.plantuml.com/plantuml'

docs/modules/ROOT/pages/getting-started/assembly-installing-the-registry-openshift.adoc

@@ -5,39 +5,40 @@ include::{mod-loc}shared/all-attributes.adoc[]
 [id="installing-the-registry"]
 = Installing {registry} on OpenShift
 
-This chapter explains how to first install {registry} and then how to set up your chosen registry storage option: {kafka-streams}, embedded Infinispan, or PostgreSQL database. 
+This chapter explains how to first install {registry} and then how to set up your chosen registry storage option: {kafka-streams}, embedded Infinispan, or PostgreSQL database.
 
 .Prerequisites
 * {registry-overview}
 
 .{registry} installation
 * xref:installing-registry-operatorhub[]
 //* xref:installing-registry-kafka-streams-template-storage[]
+* xref:configuring-registry-ui[]
 
 .{kafka-streams} storage
-* xref:installing-kafka-streams-operatorhub[] 
+* xref:installing-kafka-streams-operatorhub[]
 * xref:setting-up-kafka-streams-storage[]
 
 ifdef::apicurio-registry[]
-.Embedded Infinispan storage 
-* xref:setting-up-infinispan-storage[] 
+.Embedded Infinispan storage
+* xref:setting-up-infinispan-storage[]
 
 .PostgreSQL database storage
 * xref:installing-postgresql-operatorhub[]
-* xref:setting-up-postgresql-storage[] 
+* xref:setting-up-postgresql-storage[]
 endif::[]
 
 ifdef::rh-service-registry[]
 .Embedded Infinispan storage (Technology Preview)
-* xref:setting-up-infinispan-storage[] 
+* xref:setting-up-infinispan-storage[]
 
 .PostgreSQL database storage (Technology Preview)
 * xref:installing-postgresql-operatorhub[]
-* xref:setting-up-postgresql-storage[] 
+* xref:setting-up-postgresql-storage[]
 
 [IMPORTANT]
 ====
-{registry} storage in Infinispan or PostgreSQL is a Technology Preview feature only. Technology Preview features are not supported with Red Hat production service level agreements (SLAs) and might not be functionally complete. Red Hat does not recommend using them in production. 
+{registry} storage in Infinispan or PostgreSQL is a Technology Preview feature only. Technology Preview features are not supported with Red Hat production service level agreements (SLAs) and might not be functionally complete. Red Hat does not recommend using them in production.
 
 These features provide early access to upcoming product features, enabling customers to test functionality and provide feedback during the development process. For more information about the support scope of Red Hat Technology Preview features, see https://access.redhat.com/support/offerings/techpreview.
 ====
@@ -53,6 +54,7 @@ endif::[]
 //INCLUDES
 //include::{mod-loc}getting-started/proc_installing-registry-kafka-streams-template-storage.adoc[leveloffset=+1]
 include::{mod-loc}getting-started/proc-installing-registry-operatorhub.adoc[leveloffset=+1]
+include::{mod-loc}getting-started/proc-configuring-registry-ui.adoc[leveloffset=+1]
 include::{mod-loc}getting-started/proc-installing-kafka-streams-operatorhub.adoc[leveloffset=+1]
 include::{mod-loc}getting-started/proc-setting-up-kafka-streams-storage.adoc[leveloffset=+1]
 include::{mod-loc}getting-started/proc-setting-up-infinispan-storage.adoc[leveloffset=+1]

docs/modules/ROOT/partials/getting-started/proc-adding-artifacts-using-console.adoc

@@ -4,23 +4,23 @@
 [id="adding-artifacts-using-console"]
 = Adding artifacts using the {registry} web console
 
-You can use the {registry} web console to upload event schema and API design artifacts to the registry. For more details on the artifact types that you can upload, see {registry-artifact-types}. This section shows simple examples of uploading {registry} artifacts, applying artifact rules, and adding new artifact versions.  
+You can use the {registry} web console to upload event schema and API design artifacts to the registry. For more details on the artifact types that you can upload, see {registry-artifact-types}. This section shows simple examples of uploading {registry} artifacts, applying artifact rules, and adding new artifact versions.
 
 .Prerequisites
 
-* {registry} must be installed and running in your environment. 
+* {registry} must be installed and running in your environment.
 
 .Procedure
 
-. Connect to the {registry} web console on: 
+. Connect to the {registry} web console on:
 +
 `*\http://MY_REGISTRY_URL/ui*`
 
 . Click *Upload Artifact*, and specify the following:
 ** *ID*: Use the default empty setting to automatically generate an ID, or enter a specific artifact ID.
-** *Type*: Use the default *Auto-Detect* setting to automatically detect the artifact type, or select the artifact type from the drop-down, for example, *Avro Schema* or *OpenAPI*. 
+** *Type*: Use the default *Auto-Detect* setting to automatically detect the artifact type, or select the artifact type from the drop-down, for example, *Avro Schema* or *OpenAPI*.
 +
-NOTE:  The {registry} server cannot automatically detect the *JSON Schema* artifact type. You must manually select this artifact type.
+NOTE:  The {registry} server cannot automatically detect the *Kafka Connect Schema* artifact type. You must manually select this artifact type.
 ** *Artifact*: Drag and drop or click *Browse* to upload a file, for example, `my-schema.json` or `my-openapi.json`.
 
 . Click *Upload* and view the *Artifact Details*:
@@ -30,15 +30,15 @@ image::images/getting-started/registry-web-console-artifact.png[Artifact Details
 +
 ** *Info*: Displays the artifact name, description, lifecycle status, when created, and last modified. You can click the *Edit Artifact Metadata* pencil icon to edit the artifact name and description or add labels, and click *Download* to download the artifact file locally. Also displays artifact *Content Rules* that you can enable and configure.
 ** *Documentation* (OpenAPI only): Displays automatically-generated REST API documentation.
-** *Content*: Displays a read-only view of the full artifact content. 
+** *Content*: Displays a read-only view of the full artifact content.
 
 . In *Content Rules*, click *Enable* to configure a *Validity Rule* or *Compatibility Rule*, and select the appropriate rule configuration from the drop-down. For more details, see {registry-rule-types}.
 
-. Click *Upload new version* to add a new artifact version, and drag and drop or click *Browse* to upload the file, for example, `my-schema.json` or `my-openapi.json`. 
+. Click *Upload new version* to add a new artifact version, and drag and drop or click *Browse* to upload the file, for example, `my-schema.json` or `my-openapi.json`.
 
-. To delete an artifact, click the trash icon next to *Upload new version*. 
+. To delete an artifact, click the trash icon next to *Upload new version*.
 +
-WARNING: Deleting an artifact deletes the artifact and all of its versions, and cannot be undone. Artifact versions are immutable and cannot be deleted individually.   
+WARNING: Deleting an artifact deletes the artifact and all of its versions, and cannot be undone. Artifact versions are immutable and cannot be deleted individually.
 
 .Additional resources
 * xref:browsing-artifacts-using-console[]

docs/modules/ROOT/partials/getting-started/proc-configuring-registry-ui.adoc

@@ -0,0 +1,36 @@
+
+[id="configuring-registry-ui"]
+= Configuring {registry} web console
+
+You can configure the {registry} web console in a number of ways, either to customize its behavior or to properly
+configure it for your deployment environment.
+
+== Configuring {registry} web console for deployment environment
+
+When a user navigates their browser to the {registry} web console, some initial configuration settings are loaded.
+Two important configuration properties are:
+
+* URL of the back-end API
+* URL of the front-end web console
+
+Typically {registry} will automatically detect and generate these settings, but there are some deployment environments
+where this automatic detection can fail.  When this happens, you can configure the following environment variables to
+explicitly set them:
+
+* *_REGISTRY_UI_CONFIG_APIURL_* : set to override the URL to the back-end API (example https://registry.my-domain.com/api)
+* *_REGISTRY_UI_CONFIG_UIURL_* : set to override the URL to the front-end web console (example https://registry.my-domain.com/ui)
+
+== Configuring {registry} console for read-only mode
+
+An optional feature that can be enabled in {registry} is the ability to put the web console into "Read Only"
+mode.  This mode disables all of the features in the web console that would allow a user to make changes to
+registered artifacts.  This includes (but is not limited to):
+
+* Creating an artifact
+* Uploading a new version of an artifact
+* Updating an artifact's metadata
+* Deleting an artifact
+
+To put the web console into read only mode, set the following environment variable:
+
+* *_REGISTRY_UI_FEATURES_READONLY_* : set to `true` to enable "Read Only" mode (default `false`)