Update wiki Home page for kafka-azure-schema-registry-sink

Home.md

@@ -1,21 +1,44 @@
-# Deploy the Project on CamelX Platform
+# Azure Kafka through Eventhubs with Azure Schema Registry Sink
 
-Deploy on CamelX Platform in three steps
+Send data to Kafka topics on Azure Eventhubs combined with Azure Schema Registry.
 
-## Step 1: Create a release
-From the project space, click on **"Create a release"**
+The Kamelet is able to understand the following headers to be set:
 
-The new version is automatically available in the list
+- `key` / `ce-key`: as message key
 
-## Step 2: Deploy
-Click on **"Deploy"**
+- `partition-key` / `ce-partitionkey`: as message partition key
 
-- **Version:** Select the desired release
-- **Environment:** Choose `Development`, `Staging`, or `Production` 
-- **Configuration:** Select the configuration source
-- **Resources:** Set CPU and Memory
+Both the headers are optional.
 
-## Step 3: Expose
-Enable **"Expose"**
+## Metadata
 
-Choose an **API Gateway** (Internal, Public, etc.)
+| Property | Value |
+|----------|-------|
+| Type | sink |
+| Group | Kafka |
+| Namespace | Kafka |
+| Support Level | Stable |
+| Provider | Apache Software Foundation |
+
+## Properties
+
+| Name | Type | Required | Default | Description |
+|------|------|----------|---------|-------------|
+| `topic` | string | ✓ |  | Comma separated list of Kafka topic names |
+| `bootstrapServers` | string | ✓ |  | Comma separated list of Kafka Broker URLs |
+| `securityProtocol` | string |  | `SASL_SSL` | Protocol used to communicate with brokers. SASL_PLAINTEXT, PLAINTEXT, SASL_SSL and SSL are supported |
+| `saslMechanism` | string |  | `PLAIN` | The Simple Authentication and Security Layer (SASL) Mechanism used. |
+| `password` | string | ✓ |  | Password to authenticate to kafka |
+| `valueSerializer` | string |  | `com.microsoft.azure.schemaregistry.kafka.avro.KafkaAvroSerializer` | Deserializer class for value that implements the Deserializer interface. |
+| `azureRegistryUrl` | string | ✓ |  | The Apicurio Schema Registry URL |
+| `specificAvroValueType` | string |  |  | The Specific Type Avro will have to deal with |
+
+## Dependencies
+
+- `camel:core`
+- `camel:kafka`
+- `camel:kamelet`
+- `camel:azure-schema-registry`
+- `mvn:com.microsoft.azure:azure-schemaregistry-kafka-avro:1.1.1`
+- `mvn:com.azure:azure-data-schemaregistry-apacheavro:1.1.23`
+- `mvn:com.azure:azure-identity:1.15.0`