-
Notifications
You must be signed in to change notification settings - Fork 272
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
clean up registry user docs and restructure (#1004)
- Loading branch information
1 parent
e4d1588
commit baf90b6
Showing
37 changed files
with
360 additions
and
369 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,13 +1,14 @@ | ||
* xref:getting-started/assembly-intro-to-the-registry.adoc[] | ||
* xref:getting-started/assembly-intro-to-registry-rules.adoc[] | ||
ifdef:getting-started/:apicurio-registry[] | ||
* xref:getting-started/assembly-installing-the-registry-docker.adoc[] | ||
* xref:getting-started/assembly-installing-registry-docker.adoc[] | ||
endif:getting-started/:[] | ||
* xref:getting-started/assembly-installing-the-registry-openshift.adoc[] | ||
* xref:getting-started/assembly-installing-registry-openshift.adoc[] | ||
* xref:getting-started/assembly-installing-registry-storage-openshift.adoc[] | ||
* xref:getting-started/assembly-configuring-the-registry.adoc[] | ||
* xref:getting-started/assembly-managing-registry-artifacts-ui.adoc[] | ||
* xref:getting-started/assembly-managing-registry-artifacts-api.adoc[] | ||
* xref:getting-started/assembly-managing-registry-artifacts-maven.adoc[] | ||
* xref:getting-started/assembly-using-kafka-client-serdes.adoc[] | ||
* xref:getting-started/assembly-using-the-registry-client.adoc[] | ||
* xref:getting-started/assembly-using-kafka-client-serdes.adoc[] | ||
* xref:getting-started/assembly-registry-reference.adoc[] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
25 changes: 25 additions & 0 deletions
25
.../modules/ROOT/pages/getting-started/assembly-installing-registry-openshift.adoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
// Metadata created by nebel | ||
|
||
include::{mod-loc}shared/all-attributes.adoc[] | ||
|
||
[id="installing-registry-ocp"] | ||
= Installing {registry} on OpenShift | ||
|
||
This chapter explains how to install {registry}: | ||
|
||
* xref:installing-registry-operatorhub[] | ||
//* xref:installing-registry-kafka-streams-template-storage[] | ||
|
||
.Prerequisites | ||
* {registry-overview} | ||
|
||
NOTE: You can install more than one instance of {registry} depending on your environment. The number of instances depends on the number and type of artifacts stored in {registry}, and on your chosen storage option, for example, Kafka Streams, database, Infinispan cluster configuration. | ||
|
||
ifdef::apicurio-registry[] | ||
.Additional resources | ||
* For details on building from source, see https://github.com/Apicurio/apicurio-registry. | ||
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] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,21 @@ | ||
include::partial$shared/attributes.adoc[] | ||
|
||
= Welcome | ||
= {registry} documentation | ||
|
||
Welcome to the {registry} version {registry-version} documentation. | ||
Navigate using the left hand menu. | ||
Welcome to the {registry} version {registry-version} documentation. Navigate using the left menu. | ||
|
||
{registry} stores and retrieves API designs and event schemas, and gives you control of their evolution. | ||
|
||
|
||
== About this documentation | ||
This introduces {registry}, explains how to install with your chosen storage option, and how to manage event schemas and API designs using the {registry} web console, REST API, Maven plug-in, or Java client. | ||
|
||
This also explains how to enforce schemas using Kafka client serializers and deserializers in your consumer and producer applications. It also describes {registry} content types and rule types, and OpenShift environment variables for health checks. | ||
|
||
== Getting help with {registry} | ||
|
||
See the link:https://github.com/Apicurio/apicurio-registry[{registry}] and https://github.com/Apicurio/apicurio-registry-operator[{registry} Operator] projects on GitHub. | ||
Any contributions, suggestions, and issue reports are welcome. | ||
|
||
ifdef::apicurio-registry[] | ||
link:https://github.com/Apicurio/apicurio-registry/issues/new[Create an issue] on GitHub if you find any problems. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
67 changes: 0 additions & 67 deletions
67
docs/modules/ROOT/partials/getting-started/con-registry-artifact-metadata.adoc
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
22 changes: 4 additions & 18 deletions
22
docs/modules/ROOT/partials/getting-started/con-registry-client.adoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,24 +1,10 @@ | ||
// Metadata created by nebel | ||
|
||
[id="registry-client-intro"] | ||
= {registry} Java client overview | ||
= {registry} Java client | ||
|
||
You can manage artifacts stored in {registry} using a Java client application. You can create, read, update, or delete artifacts stored | ||
in the registry using the {registry} Java client classes. | ||
You can manage artifacts stored in {registry} using a Java client application. You can create, read, update, or delete artifacts stored in the registry using the {registry} Java client classes. | ||
|
||
You can access the {registry} Java client by adding the proper dependency to your project, see xref:writing-registry-client[]. | ||
You can access the {registry} Java client by adding the correct dependency to your project, see xref:writing-registry-client[]. | ||
|
||
The {registry} client is autocloseable and is implemented using Retrofit and OkHttp as base libraries. This gives the user the ability to customize its | ||
usage by, for example, adding custom headers or enabling TLS auth support. | ||
|
||
== Enabling TLS support in the client | ||
|
||
You can configure TLS authentication using the following properties: | ||
|
||
* apicurio.registry.request.ssl.truststore.location | ||
* apicurio.registry.request.ssl.truststore.password | ||
* apicurio.registry.request.ssl.truststore.type | ||
* apicurio.registry.request.ssl.keystore.location | ||
* apicurio.registry.request.ssl.keystore.password | ||
* apicurio.registry.request.ssl.keystore.type | ||
* apicurio.registry.request.ssl.key.password | ||
The {registry} client is auto-closeable and is implemented using Retrofit and OkHttp as base libraries. This gives you the ability to customize its use, for example, by adding custom headers or enabling Transport Layer Security (TLS) authentication. For more details, see xref:registry-client-config[]. |
Oops, something went wrong.