Skip to content

Commit 149def9

Browse files
authored
docs: minor clean up from downstream testing (#3105)
* docs: minor clean up from downstream testing * docs: clean up contrib doc, fix a few typos
1 parent 2506735 commit 149def9

11 files changed

+23
-39
lines changed

CONTRIBUTING.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -77,24 +77,24 @@ Be sure to test your pull request using all storage variants:
7777

7878
### Customizing Registry supported ArtifactTypes
7979

80-
Apicurio Registry is a modular project and it allows re-use of the produced artifacts in order to extend and enanche the functionalities.
80+
Apicurio Registry is a modular project and allows reuse of artifact types to extend and enhance functionality.
8181

82-
More specifically it's possible to modify the currently supported artifact types and add new onces by providing an higher priority `io.apicurio.registry.types.bigquery.provider.ArtifactTypeUtilProviderImpl` to the DI framework.
82+
You can modify the currently supported artifact types and add new types by providing a higher priority implementation of `io.apicurio.registry.types.<my-type>.provider.ArtifactTypeUtilProviderImpl` to the dependency injection framework.
8383

84-
In [this repository](https://github.com/andreaTP/apicurio-registry-with-bigquery-example) you can find an example where we add a demo BigQuery support.
84+
In [this GitHub repository](https://github.com/andreaTP/apicurio-registry-with-bigquery-example), you can find an example where we add demo `BigQuery` support.
8585

86-
Those are the interesting parts:
86+
The important parts are as follows:
8787

88-
- use Apicurio Registry [as a dependency](https://github.com/andreaTP/apicurio-registry-with-bigquery-example/blob/66c5d18d9c0b5e246597b79e5c5b82a54752a65d/pom.xml#L45-L49)
89-
- provide [an higher priority `ArtifactTypeUtilProviderImpl`](https://github.com/andreaTP/apicurio-registry-with-bigquery-example/blob/66c5d18d9c0b5e246597b79e5c5b82a54752a65d/src/main/java/io/apicurio/registry/types/bigquery/provider/ArtifactTypeUtilProviderImpl.java#L30-L33)
90-
- tweak [the provider list](https://github.com/andreaTP/apicurio-registry-with-bigquery-example/blob/66c5d18d9c0b5e246597b79e5c5b82a54752a65d/src/main/java/io/apicurio/registry/types/bigquery/provider/ArtifactTypeUtilProviderImpl.java#L48) in the constructor to include the additional artifact type
88+
- Use [Apicurio Registry as a dependency](https://github.com/andreaTP/apicurio-registry-with-bigquery-example/blob/66c5d18d9c0b5e246597b79e5c5b82a54752a65d/pom.xml#L45-L49)
89+
- Provide a [higher priority `ArtifactTypeUtilProviderImpl`](https://github.com/andreaTP/apicurio-registry-with-bigquery-example/blob/66c5d18d9c0b5e246597b79e5c5b82a54752a65d/src/main/java/io/apicurio/registry/types/bigquery/provider/ArtifactTypeUtilProviderImpl.java#L30-L33)
90+
- [Update the provider list](https://github.com/andreaTP/apicurio-registry-with-bigquery-example/blob/66c5d18d9c0b5e246597b79e5c5b82a54752a65d/src/main/java/io/apicurio/registry/types/bigquery/provider/ArtifactTypeUtilProviderImpl.java#L48) in the constructor to include the additional artifact type
9191

9292
**NOTES:**
9393

94-
- when creating an artifact of a type not included in the default you ALWAYS need to specify the appropriate artifact type
95-
- the UI will show the plain name of the additional type and won't have an appropriate icon to identify it
94+
- When creating an artifact of a type that is not included in the default, you must _always_ specify the appropriate artifact type.
95+
- The registry UI will show the plain name of the additional type and won't have an appropriate icon to identify it.
9696

9797
## The small print
9898

99-
This project is an open source project, please act responsibly, be nice, polite and enjoy!
99+
This project is an open source project. Please act responsibly, be nice, polite and enjoy!
100100

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

-5
Original file line numberDiff line numberDiff line change
@@ -32,9 +32,4 @@ These implementations include custom Java classes for each supported message typ
3232

3333
[role="_additional-resources"]
3434
.Additional resources
35-
ifdef::apicurio-registry,rh-service-registry[]
3635
* {kafka-client-serdes}
37-
endif::[]
38-
ifdef::rh-openshift-sr[]
39-
* link:https://access.redhat.com/documentation/en-us/red_hat_integration/2021.q3/html/service_registry_user_guide/using-kafka-client-serdes[Red Hat Integration Service Registry documentation on Kafka client SerDes]
40-
endif::[]

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

+4-4
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
{registry} provides the following options for the underlying storage of registry data:
88

99
.{registry} data storage options
10-
[%header,cols="2,4"]
10+
[%header,cols="1,3"]
1111
|===
1212
|Storage option
1313
|Description
@@ -17,14 +17,14 @@ ifdef::apicurio-registry[]
1717
|The in-memory storage option is suitable for a development environment only. All data is lost when restarting {registry} with this storage. The PostgreSQL or Kafka storage option is recommended for a production environment.
1818
endif::[]
1919

20-
|PostgreSQL {registry-db-version} database
20+
|PostgreSQL database
2121
|PostgreSQL is the recommended data storage option for performance, stability, and data management (backup/restore, and so on) in a production environment.
2222

2323
ifdef::apicurio-registry[]
24-
|Apache Kafka {registry-kafka-version}
24+
|Apache Kafka
2525
endif::[]
2626
ifdef::rh-service-registry[]
27-
|{kafka-streams} {registry-streams-version}
27+
|{kafka-streams}
2828
endif::[]
2929
|Kafka storage is provided for production environments where database management expertise is not available, or where storage in Kafka is a specific requirement.
3030
|===

docs/modules/ROOT/partials/getting-started/proc-installing-postgresql-operatorhub.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ If you do not already have a PostgreSQL database Operator installed, you can ins
2222

2323
. In the left navigation menu, click *Operators* and then *OperatorHub*.
2424

25-
. In the *Filter by keyword* text box, enter `PostgreSQL` to find an Operator suitable for your environment, for example, *Crunchy PostgreSQL for OpenShift* or *PostgreSQL Operator by Dev4Ddevs.com*.
25+
. In the *Filter by keyword* text box, enter `PostgreSQL` to find an Operator suitable for your environment, for example, *Crunchy PostgreSQL for OpenShift*.
2626

2727
. Read the information about the Operator, and click *Install* to display the Operator subscription page.
2828

docs/modules/ROOT/partials/getting-started/proc-registry-serdes-config-consumer.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ This procedure describes how to configure a Kafka consumer client written in Jav
1616

1717
. Configure the client with the URL of {registry}. For example:
1818
+
19-
[source,shell,subs="+quotes,attributes"]
19+
[source,java,subs="+quotes,attributes"]
2020
----
2121
String registryUrl = "https://registry.example.com/apis/registry/v2";
2222
Properties props = new Properties();

docs/modules/ROOT/partials/getting-started/proc-registry-serdes-config-stream.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ This procedure describes how to configure a Kafka Streams client written in Java
1616

1717
. Create and configure a Java client with the {registry} URL:
1818
+
19-
[source,shell,subs="+quotes,attributes"]
19+
[source,java,subs="+quotes,attributes"]
2020
----
2121
String registryUrl = "https://registry.example.com/apis/registry/v2";
2222

docs/modules/ROOT/partials/getting-started/proc-setting-up-postgresql-storage.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ ifdef::apicurio-registry[]
5656
. Click *Installed Operators* > *{registry}* > *ApicurioRegistry* > *Create ApicurioRegistry*.
5757
endif::[]
5858
ifdef::rh-service-registry[]
59-
. Click *Installed Operators* > *Red Hat Integration - {registry}* > *ApicurioRegistry* > *Create ApicurioRegistry*.
59+
. Click *Installed Operators* > *Red Hat Integration - Service Registry* > *ApicurioRegistry* > *Create ApicurioRegistry*.
6060
endif::[]
6161

6262
. Paste in the following custom resource definition, and edit the values for the database `url` and credentials to match your environment:

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

+1-7
Original file line numberDiff line numberDiff line change
@@ -52,10 +52,4 @@ When the client is created, you can use all the operations available in the {reg
5252
.Additional resources
5353
* For an open source example of how to use and customize the {registry} client, see the https://github.com/Apicurio/apicurio-registry-examples[Registry REST client demonstration example]
5454

55-
* For details on how to use the {registry} Kafka client serializers/deserializers (SerDes) in producer and consumer applications, see
56-
ifdef::apicurio-registry,rh-service-registry[]
57-
{kafka-client-serdes}
58-
endif::[]
59-
ifdef::rh-openshift-sr[]
60-
link:https://access.redhat.com/documentation/en-us/red_hat_integration/2021.q3/html/service_registry_user_guide/using-kafka-client-serdes[Red Hat Integration Service Registry Kafka client SerDes]
61-
endif::[]
55+
* 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/getting-started/ref-registry-client.adoc

+1-6
Original file line numberDiff line numberDiff line change
@@ -48,9 +48,4 @@ You can configure Transport Layer Security (TLS) authentication for the {registr
4848
[role="_additional-resources"]
4949
.Additional resources
5050
* For details on how to configure authentication for {registry} Kafka client serializers/deserializers (SerDes), see
51-
ifdef::apicurio-registry,rh-service-registry[]
52-
{kafka-client-serdes}
53-
endif::[]
54-
ifdef::rh-openshift-sr[]
55-
link:https://access.redhat.com/documentation/en-us/red_hat_integration/2021.q3/html/service_registry_user_guide/configuring-kafka-client-serdes[Red Hat Integration Service Registry Kafka client SerDes configuration].
56-
endif::[]
51+
{kafka-client-serdes}.

docs/modules/ROOT/partials/shared/attributes-links.adoc

+2-2
Original file line numberDiff line numberDiff line change
@@ -152,8 +152,8 @@
152152
:RegistryProductURL: service_registry
153153

154154
ifdef::RHAF[]
155-
:productpkg: apicurio_registry
156-
:RegistryProductURL: red_hat_build_of_apicurio_registry
155+
:productpkg: red_hat_build_of_apicurio_registry
156+
:RegistryProductURL: apicurio_registry
157157
:ServiceRegistryURLVersion: 2.3
158158
endif::[]
159159

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ ifndef::service-registry-downstream[]
2121
:apicurio-registry:
2222
:registry: Apicurio Registry
2323
:registry-name-full: Apicurio Registry
24-
:registry-version: 2.3
24+
:registry-version: 2.4
2525
:registry-docker-version: latest-release
2626
:registry-v1: 1.3.x
2727
:operator-version: 1.0.0

0 commit comments

Comments
 (0)