From 87b2fd77f5cba5b4baa73f3aea9087856898e2b3 Mon Sep 17 00:00:00 2001 From: Mirjam Aulbach Date: Thu, 7 Dec 2023 15:42:02 +0100 Subject: [PATCH] Add image description for sync. Signed-off-by: Mirjam Aulbach --- docs/HowTo/installation/configure-klaw-wizard.md | 6 +++--- .../HowTo/kafka-cluster-migration/sync-acls-from-cluster.md | 2 +- docs/HowTo/kafka-cluster-migration/sync-acls-to-cluster.md | 2 +- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/HowTo/installation/configure-klaw-wizard.md b/docs/HowTo/installation/configure-klaw-wizard.md index 053338e6..f905ffda 100644 --- a/docs/HowTo/installation/configure-klaw-wizard.md +++ b/docs/HowTo/installation/configure-klaw-wizard.md @@ -9,7 +9,7 @@ For subsequent logins, you access the Klaw configuration wizard using URL: [https://host:port/helpwizard] ::: -![image](../../../static/images/general/KlawWizard.png) +![Screenshot Klaw Wizard. It shows a step-by-step wizard for configuring Klaw, guiding users through the process of setting up Kafka clusters, environments, teams, users, roles, and permissions. The wizard consists of ten steps, each represented by a numbered button.](../../../static/images/general/KlawWizard.png) 1. Configure Apache Kafka® clusters @@ -49,7 +49,7 @@ URL: [https://host:port/helpwizard] After configuring environments, you can test the connection by clicking the validate button. - ![image](../../../static/images/general/EnvStatus.png) + ![Screenshot Klaw's environment page. It shows a table listing the available environments in the Klaw application. Each environment entry includes the environment name, cluster name, tenant name, additional parameters, status, and actions. A search bar and an "Add Environment" button are also present.](../../../static/images/general/EnvStatus.png) 4. Configure Tenant and Environment hierarchy @@ -85,7 +85,7 @@ URL: [https://host:port/helpwizard] Users can synchronize topics from cluster to Klaw with `SYNC_TOPICS` permission. - ![image](../../../static/images/topic/SyncTopicsFromCluster.png) + ![Screenshot Klaw's Synchronize Topics from Cluster page. It shows a list of topics synchronized from a specific Kafka cluster. The list is organized into columns that display the topic name, partitions, replication factor and a editable input field for team, prefilled.](../../../static/images/topic/SyncTopicsFromCluster.png) 6. Create Teams diff --git a/docs/HowTo/kafka-cluster-migration/sync-acls-from-cluster.md b/docs/HowTo/kafka-cluster-migration/sync-acls-from-cluster.md index 8a287bde..2a9b41ea 100644 --- a/docs/HowTo/kafka-cluster-migration/sync-acls-from-cluster.md +++ b/docs/HowTo/kafka-cluster-migration/sync-acls-from-cluster.md @@ -17,7 +17,7 @@ in Klaw. 2. Choose one or more ACLs from the list, assign them to a team, and select **Save**. The selected ACLs will now appear on the topic overview page, assigned to the chosen team. - ![image](../../../static/images/sync/SyncAclsFromCluster.png) + ![Screenshot Klaw's Synchronize ACLs from Cluster page. It shows a list of ACLs synchronized from a specific Kafka cluster. The list is organized into columns that display the topic name, partitions, replication factor, team, and a brief description. A search bar allows users to filter the list of topics based on specific criteria. There is a select element to filter the table by environment.](../../../static/images/sync/SyncAclsFromCluster.png) 3. To view all existing ACLs, whether assigned to teams or not, select the **Show all** option. This will display all Apache Kafka ACLs, both assigned and unassigned to any teams. diff --git a/docs/HowTo/kafka-cluster-migration/sync-acls-to-cluster.md b/docs/HowTo/kafka-cluster-migration/sync-acls-to-cluster.md index 603cb22b..50ad18ad 100644 --- a/docs/HowTo/kafka-cluster-migration/sync-acls-to-cluster.md +++ b/docs/HowTo/kafka-cluster-migration/sync-acls-to-cluster.md @@ -17,7 +17,7 @@ them on the Apache Kafka cluster. 2. Select the source environment (Klaw metadata with topics) and target environment (Apache Kafka cluster where ACLs have to be created) - ![image](../../../static/images/sync/SyncTopicsToCluster.png) + ![Screenshot Klaw's Synchronize ACLs to Cluster page. It shows a list of ACLs that can be chosen by checking a checkbox to be synchronized to a specific Kafka cluster. The list is organized into columns that display the topic name, the environment and the team. Below the table is a form to create topics on target environment where user can chose between to synchronise only the selected or all topics. The user can configure from which Klaw environment to which Cluster environment the data is synced.](../../../static/images/sync/SyncTopicsToCluster.png) By following these steps, you can create ACLs on any Apache Kafka cluster.