Adding topic overview (#93)

* Adding topic overview

Signed-off-by: muralibasani <[email protected]>

* Reviewed and edited content to add more information

Signed-off-by: Harshini Rangaswamy <[email protected]>

* Removed duplicate content

Signed-off-by: Harshini Rangaswamy <[email protected]>

* Run prettier check

Signed-off-by: Harshini Rangaswamy <[email protected]>

* (fix): Update custom css (#90)

Update custom css

Signed-off-by: Mirjam Aulbach <[email protected]>

* Add workflow for linting and markdown-link-check (#87)

- Add workflow for linting.
- Add script to check markdown links.
- Add explanation to script.
- Add github workflow for link-check.
- Add README for github workflows.

---------

Signed-off-by: Mirjam Aulbach <[email protected]>

* Setup vale (#92)

* Add basic vale setup with base rules.
* Fix some spelling inconsistencies
* Add workflow for vale
* Update documentation

---------

Signed-off-by: Mirjam Aulbach <[email protected]>

* Add tech docs for contributing (#96)

* Add CONTRIBUTING file with first important information.
* Update TOC and language.
* Reviewed and updated sentences in the  CONTRIBUTING file
* Rewrote sentence to provide more clarity

---------

Signed-off-by: Mirjam Aulbach <[email protected]>
Signed-off-by: Harshini Rangaswamy <[email protected]>
Co-authored-by: Harshini Rangaswamy <[email protected]>

* (fix): 🐛 duplicate documentation pages created (#94)

* Delete index.md file in concept and howto as they are generated in category.json


---------

Signed-off-by: Mirjam Aulbach <[email protected]>

* Configure vale more (#97)

* Use style config instead of dic for common words.

Signed-off-by: Mirjam Aulbach <[email protected]>

* Add custom styles for heading and whitespaces.

Signed-off-by: Mirjam Aulbach <[email protected]>

* Add proselint

Signed-off-by: Mirjam Aulbach <[email protected]>

* Add branding file.

Signed-off-by: Mirjam Aulbach <[email protected]>

* Be more specific with config.

Signed-off-by: Mirjam Aulbach <[email protected]>

* Update vale workflow.

Signed-off-by: Mirjam Aulbach <[email protected]>

* Add updated style rules.

Signed-off-by: Mirjam Aulbach <[email protected]>

---------

Signed-off-by: Mirjam Aulbach <[email protected]>

* Add additional rules (#108)

* Add style rule for postgresdb

Signed-off-by: Mirjam Aulbach <[email protected]>

* Add rule for condensending language

Signed-off-by: Mirjam Aulbach <[email protected]>

* Add rule for use of race related words and update error.

Signed-off-by: Mirjam Aulbach <[email protected]>

---------

Signed-off-by: Mirjam Aulbach <[email protected]>

* Update docs to use SSL correctly (#112)

Signed-off-by: Devrishi <[email protected]>

* Add first entries to style guide (#107)

Add first entries to style guide.

Signed-off-by: Mirjam Aulbach <[email protected]>

* fixes: Update doc term klaw correctly (#114)

* fixes: Update doc term klaw correctly

---------

Signed-off-by: Basavarajakjbasuu <[email protected]>

* (ci) Update vale workflow reporter (#115)

* Remove vale action in favor for own setup for workflow

Signed-off-by: Mirjam Aulbach <[email protected]>

* Move klaw rule to temp branding again.

Signed-off-by: Mirjam Aulbach <[email protected]>

* Fix spelling error.

Signed-off-by: Mirjam Aulbach <[email protected]>

---------

Signed-off-by: Mirjam Aulbach <[email protected]>

* Updated branding.yml and respective files to help docs to use the term "Confluent Cloud" correctly. (#122)

Updated branding.yml and respective files to help docs to use the term Confluent Cloud correctly

Signed-off-by: Roshan Goswami <[email protected]>

* Update docs to use Klaw Cluster API correctly  (#125)

Update docs to use Klaw Cluster API corrrectly

Signed-off-by: Devrishi <[email protected]>

* Added readme to spelling-klaw-vocabulary file

Signed-off-by: Harshini Rangaswamy <[email protected]>

---------

Signed-off-by: muralibasani <[email protected]>
Signed-off-by: Harshini Rangaswamy <[email protected]>
Signed-off-by: Mirjam Aulbach <[email protected]>
Signed-off-by: Devrishi <[email protected]>
Signed-off-by: Basavarajakjbasuu <[email protected]>
Signed-off-by: Roshan Goswami <[email protected]>
Co-authored-by: muralibasani <[email protected]>
Co-authored-by: Harshini Rangaswamy <[email protected]>
Co-authored-by: Mirjam Aulbach <[email protected]>
Co-authored-by: Devrishi Dutta <[email protected]>
Co-authored-by: Basavaraja K J <[email protected]>
Co-authored-by: Roshan <[email protected]>
Co-authored-by: Harshini Rangaswamy <[email protected]>

.github/vale/styles/Klaw/spelling-klaw-vocabulary.txt

@@ -22,6 +22,7 @@ OSPO
 Okta
 Postgres
 Readme
+readme
 Requestor
 Requestors
 Superadmin

docs/HowTo/topics/Topic-overview.md

@@ -0,0 +1,46 @@
+# Topic overview
+
+When you choose a topic on Klaw, you will be directed to the **Topic overview** page, where you can find comprehensive information about the topic's settings, subscriptions, messages, and more, offering a holistic view to manage and understand your selected topic effectively.
+
+## Overview tab
+
+In this tab, you can view the topic's settings, connection details, subscriptions, and schemas overview.
+
+- **Topic details**: In this section, you can view the settings related to the topic, such as partitions, replication factors, and any advanced configurations.
+- **Cluster details**: This section provides key information about the cluster, such as the Bootstrap server address for connections, the protocol used, and the specific Kafka version. You can also see the cluster name, current status, and associated REST API details.
+- **Subscriptions & schemas**: This section displays the total count of producers and consumers subscribed to the topic and the number of associated schemas. You can directly **Request new subscription** or **Request new schema** as needed. To view the current subscriptions and schemas, click the **See subscriptions** and **See schema** options.
+
+## Subscriptions tab
+
+Accessing this tab, you're presented with an overview of producers and consumers associated with the topic. Here's what you can do:
+
+- **Request a new subscription**: Directly initiate the process to add a new subscription.
+- **Filter subscriptions**: Use the dropdown menus to narrow down your view by team or ACL type.
+- **Search**: If you're trying to find a specific principal or IP, use the search bar. It recognizes partial matches and starts searching as you type. To clear your search, press the "Escape" key.
+- **Subscription types**: Use the tabs like "User subs.", "Prefixed subs.", and "Transactional subs." to see different types of subscriptions.
+
+## Messages tab
+
+This tab allows you to view messages or events associated with the topic. For this feature to be accessible, a consumer group needs to be configured in the Klaw Cluster API. Ensure it's set up using the
+
+    klaw.topiccontents.consumergroup.id
+
+## Schemas tab
+
+Within this tab, you can explore all Avro schemas and their versions related to the topic. Additionally, you have the flexibility to request a new schema or promote an existing one.
+
+## Readme tab
+
+Readme provides essential information, guidelines, and explanations about the topic, helping team members understand its purpose and usage. Edit the readme to update the information as the topic evolves. You can write and format your notes easily as this tab supports markdown following the CommonMark standard. You can also search for specific information within your notes.
+
+## History tab
+
+In this tab, you can view a detailed audit of every topic request, promotion request, configuration update, and ACL request made for the topic. It provides a comprehensive record, ensuring complete visibility of all topic-related actions.
+
+## Settings tab
+
+If you're using the new React user interface, you can request to delete a topic in this tab. For Angular interface users, this option is available in the **Overview** tab.
+
+For a visual summary of the **Topic overview**, check the image below.
+
+![image](../../../static/images/topic/TopicOverview.png)