Add new category Klaw workflows

Signed-off-by: Mirjam Aulbach <[email protected]>
Aiven-Open · Feb 2, 2024 · 179f772 · 179f772
1 parent ffa391b
commit 179f772
Show file tree

Hide file tree

Showing 26 changed files with 131 additions and 68 deletions.
diff --git a/_redirects b/_redirects
@@ -68,4 +68,25 @@
 /docs/Concepts/metastore               /docs/metadata-management/metastore 301
 /docs/HowTo/exportimport/              /docs/metadata-management/import-export 301
 /docs/HowTo/exportimport/exportdata    /docs/metadata-management/import-export/exportdata 301
-/docs/HowTo/exportimport/importdata    //docs/metadata-management/import-export/importdata 301
+/docs/HowTo/exportimport/importdata    /docs/metadata-management/import-export/importdata 301
+
+/docs/Concepts/promotion                            /docs/workflows/promotion 301
+/docs/HowTo/schemas                                 /docs/workflows/schema 301
+/docs/HowTo/schemas/manage-schemas                  /docs/workflows/schema/manage-schema-requests 301
+/docs/HowTo/schemas/My-schema-requests              /docs/workflows/schema/my-schema-requests 301
+/docs/HowTo/schemas/Promote-a-schema                /docs/workflows/schema/promote-schema 301
+/docs/HowTo/schemas/Request-a-schema                /docs/workflows/schema/request-schema 301
+/docs/HowTo/subscriptions                           /docs/workflows/subscription 301
+/docs/HowTo/subscriptions/Approve-a-subscription    /docs/workflows/subscription/manage-subscription-requests 301
+/docs/HowTo/subscriptions/Delete-a-subscription     /docs/workflows/subscription/delete-subscription 301
+/docs/HowTo/subscriptions/My-subscription-requests  /docs/workflows/subscription/my-subscription-requests  301
+/docs/HowTo/subscriptions/Request-a-subscription    /docs/workflows/subscription/request-subscription 301
+/docs/HowTo/topics/                                 /docs/workflows/topic 301
+/docs/HowTo/topics/Approve-a-topic                  /docs/workflows/topic/manage-topic-requests 301
+/docs/HowTo/topics/Claim-a-topic                    /docs/workflows/topic/claim-topic 301
+/docs/HowTo/topics/Delete-a-topic                   /docs/workflows/topic/delete-topic 301
+/docs/HowTo/topics/Edit-topic-request               /docs/workflows/topic/edit-topic 301
+/docs/HowTo/topics/My-topic-requests                /docs/workflows/topic/my-topic-requests 301
+/docs/HowTo/topics/Promote-a-topic                  /docs/workflows/topic/promote-topic 301
+/docs/HowTo/topics/Request-a-new-topic              /docs/workflows/topic/request-topic 301
+/docs/HowTo/topics/Topic-overview                   /docs/workflows/topic/topic-overview 301
diff --git a/blog/2023/09/schema-management-disaster-recovery-in-klaw.md b/blog/2023/09/schema-management-disaster-recovery-in-klaw.md
@@ -140,7 +140,7 @@ As the topic owner, you have the authority to approve, initiate, or reject any s
 
 ![image](../../../static/images/blogimages/SchemaRequest-Workflow.png)
 
-For more information on registering a schema **[see here](/docs/HowTo/schemas/Request-a-schema)**
+For more information on registering a schema **[see here](/docs/workflows/schema/request-schema)**
 
 Watch the video below for a step-by-step demonstration of registering a schema in Klaw.
 

diff --git a/current-routes.json b/current-routes.json
@@ -59,7 +59,6 @@
   "/docs/cluster-management/kafka-cluster-sync/sync-schemas-to-cluster",
   "/docs/cluster-management/kafka-cluster-sync/sync-topics-from-cluster",
   "/docs/cluster-management/kafka-cluster-sync/sync-topics-to-cluster",
-  "/docs/Concepts/promotion",
   "/docs/Concepts/synchronize",
   "/docs/Concepts/workflows",
   "/docs/connector-management/",
@@ -79,27 +78,8 @@
   "/docs/HowTo/notifications/slack-notification",
   "/docs/HowTo/operational/",
   "/docs/HowTo/operational/Reset-Consumer-Offsets",
-  "/docs/HowTo/schemas/",
-  "/docs/HowTo/schemas/manage-schemas",
-  "/docs/HowTo/schemas/My-schema-requests",
-  "/docs/HowTo/schemas/Promote-a-schema",
-  "/docs/HowTo/schemas/Request-a-schema",
-  "/docs/HowTo/subscriptions/",
-  "/docs/HowTo/subscriptions/Approve-a-subscription",
-  "/docs/HowTo/subscriptions/Delete-a-subscription",
-  "/docs/HowTo/subscriptions/My-subscription-requests",
-  "/docs/HowTo/subscriptions/Request-a-subscription",
   "/docs/HowTo/teams/",
   "/docs/HowTo/teams/switch-teams",
-  "/docs/HowTo/topics/",
-  "/docs/HowTo/topics/Approve-a-topic",
-  "/docs/HowTo/topics/Claim-a-topic",
-  "/docs/HowTo/topics/Delete-a-topic",
-  "/docs/HowTo/topics/Edit-topic-request",
-  "/docs/HowTo/topics/My-topic-requests",
-  "/docs/HowTo/topics/Promote-a-topic",
-  "/docs/HowTo/topics/Request-a-new-topic",
-  "/docs/HowTo/topics/Topic-overview",
   "/docs/HowTo/topics/View-consumer-lag",
   "/docs/HowTo/topics/View-topic-events",
   "/docs/HowTo/zothers",
@@ -135,5 +115,25 @@
   "/docs/user-team-management/teams/manage-teams",
   "/docs/user-team-management/teams/switch-teams",
   "/docs/user-team-management/users-roles-teams",
+  "/docs/workflows/promotion",
+  "/docs/workflows/schema/",
+  "/docs/workflows/schema/manage-schema-requests",
+  "/docs/workflows/schema/my-schema-requests",
+  "/docs/workflows/schema/promote-schema",
+  "/docs/workflows/schema/request-schema",
+  "/docs/workflows/subscription/",
+  "/docs/workflows/subscription/delete-subscription",
+  "/docs/workflows/subscription/manage-subscription-requests",
+  "/docs/workflows/subscription/my-subscription-requests",
+  "/docs/workflows/subscription/request-subscription",
+  "/docs/workflows/topic/",
+  "/docs/workflows/topic/claim-topic",
+  "/docs/workflows/topic/delete-topic",
+  "/docs/workflows/topic/edit-topic",
+  "/docs/workflows/topic/manage-topic-requests",
+  "/docs/workflows/topic/my-topic-requests",
+  "/docs/workflows/topic/promote-topic",
+  "/docs/workflows/topic/request-topic",
+  "/docs/workflows/topic/topic-overview",
   "/"
 ]
diff --git a/docs/getting-started/features.md b/docs/getting-started/features.md
@@ -8,13 +8,13 @@ Explore the comprehensive range of features Klaw offers to manage your Apache Ka
 
 | Feature                                                                                                      | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
 | ------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| [_Topics creation_](../HowTo/topics/Request-a-new-topic.md)                                                  | Easily request and approve Apache Kafka topics for your applications.                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
-| [_ACLs creation_](../HowTo/subscriptions/Request-a-subscription.md)                                          | Manage access control by requesting and approving Producer and Consumer access to Apache Kafka topics.                                                                                                                                                                                                                                                                                                                                                                                                                                 |
-| [_Schemas creation_](../HowTo/schemas/Request-a-schema.md)                                                   | Request and approve Avro schemas, compatible with Karapace and Confluent Schema Registry.                                                                                                                                                                                                                                                                                                                                                                                                                                              |
+| [_Topics creation_](../workflows/topic/request-topic.md)                                                     | Easily request and approve Apache Kafka topics for your applications.                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
+| [_ACLs creation_](../workflows/subscription/request-subscription.md)                                         | Manage access control by requesting and approving Producer and Consumer access to Apache Kafka topics.                                                                                                                                                                                                                                                                                                                                                                                                                                 |
+| [_Schemas creation_](../workflows/schema/request-schema.md)                                                  | Request and approve Avro schemas, compatible with Karapace and Confluent Schema Registry.                                                                                                                                                                                                                                                                                                                                                                                                                                              |
 | [_Connectors creation_](../connector-management/approve-connector.md)                                        | Request and approve Apache Kafka Connectors for streamlined data integration.                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
-| [_Promote topics, schemas, connectors_](../HowTo/topics/Promote-a-topic.md)                                  | Define a hierarchy of environments and effortlessly promote entities to higher environments.                                                                                                                                                                                                                                                                                                                                                                                                                                           |
+| [_Promote topics, schemas, connectors_](../workflows/topic/promote-topic.md)                                 | Define a hierarchy of environments and effortlessly promote entities to higher environments.                                                                                                                                                                                                                                                                                                                                                                                                                                           |
 | [_Topic naming conventions_](../cluster-management/clusters-environments/environments.md)                    | Enforce naming conventions using prefixes, suffixes, or regex on topic names.                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
-| [_Schema evolution_](../HowTo/schemas/manage-schemas.md)                                                     | Manage multiple versions of schemas efficiently.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
+| [_Schema evolution_](../workflows/schema/manage-schema-requests.md)                                          | Manage multiple versions of schemas efficiently.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 | [_Reset consumer offsets_](../HowTo/operational/Reset-Consumer-Offsets.md)                                   | Gain the ability to reset consumer offsets for specific consumer groups per topic.                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
 | [_View Apache Kafka events_](../HowTo/topics/View-topic-events)                                              | Easily view events on any Apache Kafka topic for better monitoring and debugging.                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
 | [_Dashboard_](../HowTo/dashboard)                                                                            | Access dashboard to see the topics for which your team has created ACLs, both as a producer and consumer.                                                                                                                                                                                                                                                                                                                                                                                                                              |

diff --git a/docs/releases/release200.md b/docs/releases/release200.md
@@ -58,7 +58,7 @@ force-register the schema in case of any compatibility issues during
 registration.
 
 For more information, see [Schema
-Promotion](../../docs/HowTo/schemas/Promote-a-schema).
+Promotion](../../docs/workflows/schema/promote-schema).
 
 ### Authorization from OAuth2 Provider/Active Directory
 

diff --git a/docs/Concepts/promotion.md → docs/workflows/promotion.md b/docs/Concepts/promotion.md → docs/workflows/promotion.md
@@ -49,5 +49,5 @@ promotion defined in `orderOfTopicPromotionEnvsList`.
 
 ## How to promote topics and schemas
 
-- [Promote a topic](../HowTo/topics/Promote-a-topic.md)
-- [Promote a schema](../HowTo/schemas/Promote-a-schema.md)
+- [Promote a topic](../workflows/topic/promote-topic.md)
+- [Promote a schema](../workflows/schema/promote-schema.md)
diff --git a/docs/HowTo/schemas/index.md → docs/workflows/schema/index.md b/docs/HowTo/schemas/index.md → docs/workflows/schema/index.md
@@ -35,10 +35,7 @@ Schema management in Klaw is structured around the following:
 
 ## Learn how to
 
-- [Request a schema](Request-a-schema.md)
-
-- [Promote a schema](Promote-a-schema.md)
-
-- [Approve a schema](manage-schemas.md)
-
-- [My Schema Requests](My-schema-requests.md)
+- [Request a new schema](request-schema.md)
+- [Promote a schema](promote-schema.md)
+- [Manage schema requests](manage-schema-requests.md)
+- [My schema requests](my-schema-requests.md)
diff --git a/docs/HowTo/schemas/manage-schemas.md → ...orkflows/schema/manage-schema-requests.md b/docs/HowTo/schemas/manage-schemas.md → ...orkflows/schema/manage-schema-requests.md
@@ -1,4 +1,4 @@
-# Manage schema
+# Manage schema requests
 
 When a schema request is made, a team member other than the request
 creator can review, approve, or decline the request. Schema requests can

diff --git a/docs/HowTo/schemas/My-schema-requests.md → docs/workflows/schema/my-schema-requests.md b/docs/HowTo/schemas/My-schema-requests.md → docs/workflows/schema/my-schema-requests.md
@@ -1,4 +1,4 @@
-# My Schema Requests
+# My schema requests
 
 To access the **My Schema Requests** page, navigate to the **Requests
 -\> My Schema Requests** section. On this page, you can view all the

diff --git a/docs/HowTo/schemas/Promote-a-schema.md → docs/workflows/schema/promote-schema.md b/docs/HowTo/schemas/Promote-a-schema.md → docs/workflows/schema/promote-schema.md
@@ -5,13 +5,13 @@ administration, and control of schemas. With schema promotion, a schema
 can be initially created in the lowest environment and then promoted to
 higher environments as needed.
 
-Learn more: [Concepts—Promotion](../../Concepts/promotion.md)
+Learn more: [Concepts—Promotion](../../workflows/promotion.md)
 
 ## Prerequisites
 
 Before using this functionality, the Superadmin must ensure that all
 prerequisites are met. For more information, see
-[Promotion](../../Concepts/promotion.md).
+[Promotion](../../workflows/promotion.md).
 
 ## Schema promotion step by step
 

diff --git a/docs/HowTo/schemas/Request-a-schema.md → docs/workflows/schema/request-schema.md b/docs/HowTo/schemas/Request-a-schema.md → docs/workflows/schema/request-schema.md
diff --git a/...To/subscriptions/Delete-a-subscription.md → ...flows/subscription/delete-subscription.md b/...To/subscriptions/Delete-a-subscription.md → ...flows/subscription/delete-subscription.md
diff --git a/docs/HowTo/subscriptions/index.md → docs/workflows/subscription/index.md b/docs/HowTo/subscriptions/index.md → docs/workflows/subscription/index.md
@@ -43,10 +43,7 @@ subscription, the team that owns the topic is responsible for making the
 final decision, such as approving or declining a request from the same
 team or another team to produce/consume events from the topic.
 
-- [Request a subscription](Request-a-subscription.md)
-
-- [Approve a subscription](Approve-a-subscription.md)
-
-- [Delete a subscription](Delete-a-subscription.md)
-
-- [My Subscription Requests](My-subscription-requests.md)
+- [Request a new subscription](request-subscription.md)
+- [Manage subscription requests](manage-subscription-requests.md)
+- [Delete a subscription](delete-subscription.md)
+- [My subscription requests](my-subscription-requests.md)
diff --git a/...o/subscriptions/Approve-a-subscription.md → ...scription/manage-subscription-requests.md b/...o/subscriptions/Approve-a-subscription.md → ...scription/manage-subscription-requests.md
@@ -1,4 +1,4 @@
-# Manage subscriptions
+# Manage subscription requests
 
 When a team member makes a subscription request, it must be reviewed and
 approved or declined by another team member. This applies to producer

diff --git a/...subscriptions/My-subscription-requests.md → .../subscription/my-subscription-requests.md b/...subscriptions/My-subscription-requests.md → .../subscription/my-subscription-requests.md
@@ -1,4 +1,4 @@
-# My Subscription Requests
+# My subscription requests
 
 To access the **My ACL Requests** page, navigate to the **Requests -\>
 My ACL Requests**. On this page, you can see all the requests created by

diff --git a/...o/subscriptions/Request-a-subscription.md → ...lows/subscription/request-subscription.md b/...o/subscriptions/Request-a-subscription.md → ...lows/subscription/request-subscription.md
@@ -1,4 +1,4 @@
-# Request a new Subscription
+# Request a new subscription
 
 The process for requesting a new subscription to be created in Apache Kafka® is
 straightforward and efficient. The team that owns the relevant topic is

diff --git a/docs/HowTo/topics/Claim-a-topic.md → docs/workflows/topic/claim-topic.md b/docs/HowTo/topics/Claim-a-topic.md → docs/workflows/topic/claim-topic.md
diff --git a/docs/HowTo/topics/Delete-a-topic.md → docs/workflows/topic/delete-topic.md b/docs/HowTo/topics/Delete-a-topic.md → docs/workflows/topic/delete-topic.md
diff --git a/docs/HowTo/topics/Edit-topic-request.md → docs/workflows/topic/edit-topic.md b/docs/HowTo/topics/Edit-topic-request.md → docs/workflows/topic/edit-topic.md