Skip to content

Commit

Permalink
Add new category Getting started
Browse files Browse the repository at this point in the history
Signed-off-by: Mirjam Aulbach <[email protected]>
  • Loading branch information
programmiri committed Feb 1, 2024
1 parent 87cc540 commit 8e012c8
Show file tree
Hide file tree
Showing 8 changed files with 83 additions and 57 deletions.
8 changes: 7 additions & 1 deletion _redirects
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,10 @@
/docs/category/Releases /docs/releases 301

/docs/category/concepts /docs/Concepts/clusters-environments 301
/docs/category/howto /docs/HowTo/analytics 301
/docs/category/howto /docs/HowTo/analytics 301

/docs/features /docs/getting-started/features 301
/docs/getstarted /docs/getting-started/getstarted 301
/docs/quickstart /docs/getting-started/quickstart 301


6 changes: 3 additions & 3 deletions current-routes.json
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,9 @@
"/docs/Concepts/users-teams",
"/docs/Concepts/workflows",
"/docs/faq",
"/docs/features",
"/docs/getstarted",
"/docs/getting-started/features",
"/docs/getting-started/getstarted",
"/docs/getting-started/quickstart",
"/docs/HowTo/analytics",
"/docs/HowTo/authentication/",
"/docs/HowTo/authentication/azure-ad",
Expand Down Expand Up @@ -121,7 +122,6 @@
"/docs/HowTo/topics/View-topic-events",
"/docs/HowTo/users",
"/docs/HowTo/zothers",
"/docs/quickstart",
"/docs/releases",
"/docs/releases/release100",
"/docs/releases/release110",
Expand Down
41 changes: 0 additions & 41 deletions docs/features.md

This file was deleted.

41 changes: 41 additions & 0 deletions docs/getting-started/features.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
---
sidebar_position: 1
---

# Features of Klaw

Explore the comprehensive range of features Klaw offers to manage your Apache Kafka® ecosystem more efficiently.

| 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. |
| [_Connectors creation_](../HowTo/connectors/Request-a-new-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. |
| [_Topic naming conventions_](../HowTo/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. |
| [_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. |
| [_View consumer lag_](../HowTo/topics/View-consumer-lag) | Keep track of consumer offsets and view lags for a consumer group. |
| [_Sync topics to a cluster_](../HowTo/kafka-cluster-migration/sync-topics-to-cluster.md) | Synchronize topics with any new or existing Apache Kafka cluster seamlessly. |
| [_Sync topics from a cluster_](../HowTo/kafka-cluster-migration/sync-topics-from-cluster.md) | Synchronize topics from any Apache Kafka cluster to Klaw. |
| [_Sync ACLs to a cluster_](../HowTo/kafka-cluster-migration/sync-acls-to-cluster.md) | Ensure access control by synchronizing access control lists with new or existing Apache Kafka clusters. |
| [_Sync ACLs from a cluster_](../HowTo/kafka-cluster-migration/sync-acls-from-cluster.md) | Ensure the security of your Apache Kafka topics by synchronizing access control lists from any Apache Kafka cluster with Klaw. |
| [_Sync schemas to a cluster_](../HowTo/kafka-cluster-migration/sync-schemas-to-cluster.md) | Maintain consistency by synchronizing schemas, including all versions, to new or existing Schema Registry clusters. |
| [_Sync schemas from a cluster_](../HowTo/kafka-cluster-migration/sync-schemas-from-cluster.md) | Ensure schema consistency by synchronizing schemas from any Schema Registry cluster to Klaw. |
| [_Sync connectors from a cluster_](../HowTo/kafka-cluster-migration/sync-connectors-from-cluster.md) | Efficiently manage connectors by syncing them from any Apache Kafka Connect cluster to Klaw. |
| [_Import / Export Klaw data_](../HowTo/exportimport/index.md) | Easily export Klaw metadata to JSON files and import it into another Klaw instance for data security and smooth transitions. |
| Secured Apache Kafka topics | Secure and protect Apache Kafka topics, schemas, and access control lists with defined ownership and access control. |
| [_Controlled access to users_](../HowTo/rolespermissions.md) | Define granular roles and permissions, allowing users to view, request, and modify entities as needed. |
| [_Apache Kafka connectivity PLAINTEXT/SSL/SASL_](../HowTo/clusterconnectivity/index.md) | Connect Klaw to Apache Kafka clusters using PLAINTEXT, SSL, or SASL mechanisms. |
| [_Email Notifications_](../HowTo/notifications/index.md) | Stay informed with email notifications for every request, approval, and Apache Kafka cluster change. |
| [_Analytics / Reports_](../HowTo/analytics.md) | Access and download reports on your requests, topics, consumer groups, and ACL ownership in Klaw. Data availability varies based on your role as USER or SUPERADMIN. |
| Audit history | Keep track of every request, approval, and change with a comprehensive audit history. |
| [_Apache Kafka flavor support_](../HowTo/clusters.md) | Klaw is compatible with multiple Apache Kafka flavors, including Apache Kafka, Aiven Apache Kafka, Confluent Apache Kafka, and Confluent Cloud Apache Kafka. |
| [_Klaw login AD/SSO/DB_](../HowTo/authentication/index.md) | Users can log in to Klaw using Windows AD or SSO providers like Azure and Google. |

:::note
Klaw is continuously evolving, and many other minor features are also available that are not listed above.
:::
4 changes: 2 additions & 2 deletions docs/getstarted.md → docs/getting-started/getstarted.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
sidebar_position: 1.3
sidebar_position: 3
---

# Get started

## With Klaw and Apache Kafka®

If you have not setup Klaw, see [Klaw installation](HowTo/installation).
If you have not setup Klaw, see [Klaw installation](../HowTo/installation).
Once Klaw is up and running, the next step is to connect it to your
Apache Kafka service. Whether you are running this locally, or using a
hosted service, the steps below will get you started.
Expand Down
12 changes: 6 additions & 6 deletions docs/quickstart.md → docs/getting-started/quickstart.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 1.1
sidebar_position: 2
---

# Quick Start
Expand All @@ -26,7 +26,7 @@ After docker has started 5 processes, you may verify them by `docker ps`.
Now you may log into Klaw on `http://localhost:9097` with
credentials `william : welcome` <!--vale NO_SPELL-->

![Screenshot: Klaw's login page](../static/images/quickstart/QS_LoginScreen.png)
![Screenshot: Klaw's login page](../../static/images/quickstart/QS_LoginScreen.png)

## 3. Topics Catalog page

Expand All @@ -35,11 +35,11 @@ After logging in you will be redirected to our brand-new feature rich React UI.
You can "Request new Topic" from the top right corner, or you can select the dropdown "Request a new" to view all your
options.

![Screenshot: Topic catalog page](../static/images/quickstart/AfterLogin.png)
![Screenshot: Topic catalog page](../../static/images/quickstart/AfterLogin.png)

## 4. Request for topic

![Screenshot: Form to request a new topic](../static/images/quickstart/RequestForTopic.png)
![Screenshot: Form to request a new topic](../../static/images/quickstart/RequestForTopic.png)

Fill in the details

Expand All @@ -55,7 +55,7 @@ This will create a topic request for your team member to approve.

Newly created topic request is now visible in **My team's requests** menu on the sidebar

![Screenshot: "My team's requests" page](../static/images/quickstart/MyRequest.png)
![Screenshot: "My team's requests" page](../../static/images/quickstart/MyRequest.png)

## 6. Logout

Expand All @@ -75,7 +75,7 @@ From the menu, click on "Approve requests" menu.

Here there is a pending request to be approved or declined. Click on view to review and approve it.

![Screenshot: "Approve request" page](../static/images/quickstart/ApproveReq.png)
![Screenshot: "Approve request" page](../../static/images/quickstart/ApproveReq.png)

## 10. That's it. Topic is created on Apache Kafka cluster

Expand Down
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,4 @@ Klaw consists of two components:
## Quickstart

Copy the docker script and run. It installs Klaw, Apache Kafka, and schema Schema Registry servers as docker processes. [**Go through
this guide**](./quickstart)
this guide**](./getting-started/quickstart)
Loading

0 comments on commit 8e012c8

Please sign in to comment.