You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: CONTRIBUTING.md
+10-10
Original file line number
Diff line number
Diff line change
@@ -77,24 +77,24 @@ Be sure to test your pull request using all storage variants:
77
77
78
78
### Customizing Registry supported ArtifactTypes
79
79
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.
81
81
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.
83
83
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.
85
85
86
-
Those are the interesting parts:
86
+
The important parts are as follows:
87
87
88
-
-use Apicurio Registry [as a dependency](https://github.com/andreaTP/apicurio-registry-with-bigquery-example/blob/66c5d18d9c0b5e246597b79e5c5b82a54752a65d/pom.xml#L45-L49)
-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
91
91
92
92
**NOTES:**
93
93
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.
96
96
97
97
## The small print
98
98
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!
Copy file name to clipboardexpand all lines: docs/modules/ROOT/partials/getting-started/con-registry-serde.adoc
-5
Original file line number
Diff line number
Diff line change
@@ -32,9 +32,4 @@ These implementations include custom Java classes for each supported message typ
32
32
33
33
[role="_additional-resources"]
34
34
.Additional resources
35
-
ifdef::apicurio-registry,rh-service-registry[]
36
35
* {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]
Copy file name to clipboardexpand all lines: docs/modules/ROOT/partials/getting-started/con-registry-storage.adoc
+4-4
Original file line number
Diff line number
Diff line change
@@ -7,7 +7,7 @@
7
7
{registry} provides the following options for the underlying storage of registry data:
8
8
9
9
.{registry} data storage options
10
-
[%header,cols="2,4"]
10
+
[%header,cols="1,3"]
11
11
|===
12
12
|Storage option
13
13
|Description
@@ -17,14 +17,14 @@ ifdef::apicurio-registry[]
17
17
|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.
18
18
endif::[]
19
19
20
-
|PostgreSQL {registry-db-version} database
20
+
|PostgreSQL database
21
21
|PostgreSQL is the recommended data storage option for performance, stability, and data management (backup/restore, and so on) in a production environment.
22
22
23
23
ifdef::apicurio-registry[]
24
-
|Apache Kafka {registry-kafka-version}
24
+
|Apache Kafka
25
25
endif::[]
26
26
ifdef::rh-service-registry[]
27
-
|{kafka-streams} {registry-streams-version}
27
+
|{kafka-streams}
28
28
endif::[]
29
29
|Kafka storage is provided for production environments where database management expertise is not available, or where storage in Kafka is a specific requirement.
Copy file name to clipboardexpand all lines: docs/modules/ROOT/partials/getting-started/proc-installing-postgresql-operatorhub.adoc
+1-1
Original file line number
Diff line number
Diff line change
@@ -22,7 +22,7 @@ If you do not already have a PostgreSQL database Operator installed, you can ins
22
22
23
23
. In the left navigation menu, click *Operators* and then *OperatorHub*.
24
24
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*.
26
26
27
27
. Read the information about the Operator, and click *Install* to display the Operator subscription page.
Copy file name to clipboardexpand all lines: docs/modules/ROOT/partials/getting-started/proc-writing-registry-client.adoc
+1-7
Original file line number
Diff line number
Diff line change
@@ -52,10 +52,4 @@ When the client is created, you can use all the operations available in the {reg
52
52
.Additional resources
53
53
* 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]
54
54
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}.
Copy file name to clipboardexpand all lines: docs/modules/ROOT/partials/getting-started/ref-registry-client.adoc
+1-6
Original file line number
Diff line number
Diff line change
@@ -48,9 +48,4 @@ You can configure Transport Layer Security (TLS) authentication for the {registr
48
48
[role="_additional-resources"]
49
49
.Additional resources
50
50
* 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].
0 commit comments