Skip to content

Commit

Permalink
refactor: split content for promotion (#164)
Browse files Browse the repository at this point in the history
* Update promotion page to only contain general information
* Update how tos
* Add links to promotion conecpt

---------

Signed-off-by: Mirjam Aulbach <[email protected]>
  • Loading branch information
programmiri authored Nov 6, 2023
1 parent 241006e commit cf5ebc5
Show file tree
Hide file tree
Showing 3 changed files with 36 additions and 79 deletions.
53 changes: 3 additions & 50 deletions docs/Concepts/promotion.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,54 +47,7 @@ to associate a schema registry with a Apache Kafka environment in the Add/Modify
promotion defined in `orderOfTopicPromotionEnvsList`.
:::

## Topic promotion
## How to promote topics and schemas

Once a topic is created in the base environment, you can promote it to the next higher-level environment. This will
create a promotion request that your teammates can review, approve, or decline. The **Topic overview** view will show
all the environments the topic is configured on, including the environment to which you can promote the topic.

### Promote a topic

To promote a topic to a higher environment, follow these steps:

1. Select **Topics** on the navigation bar.
2. Select the specific Apache Kafka topic you want to promote to the higher environment.
3. Select the **Promote to \[Next Environment\]** button to promote the topic to the next environment (higher
environment) that has been configured.
4. Configure the number of **Partitions** and **Replication factor** for the higher environment in the dropdowns
provided.
5. Confirm the promotion to the next environment by selecting **Submit Promotion to \[Next Environment\]**
6. A topic request is now created for team members to review and approve under **Approvals**.

## Schema promotion

In the **Topic overview**, you can request and view the schema for an individual topic. Release 2.0.0 allows you to
promote existing schemas to higher-level environments. To do this, select the specific schema version you want to
promote from the lower environment to the higher environment.

### Promote a schema

To promote a schema to a higher environment, follow these steps:

1. Select **Topics** on the navigation bar.
2. Select the Apache Kafka topic for which you want to promote the schema to a higher environment.
3. Select the **Schema** tab under the main topic section.
4. Select the **Promote to \[Next Environment\]** button to promote a schema to the next environment (higher
environment) that has been configured.
5. To promote a schema to a higher environment, select the specific version of the schema that you want to promote. This
schema will be available for your team to review when approving or declining the request.
6. Optionally, you can use the **Force Register Schema** option to register a schema that is not compatible with the
existing schemas on that topic.
7. Confirm the promotion to the next environment by selecting **Submit Promotion to \[Next Environment\]**.
8. A schema request is now created for team members to review and approve under **Approvals**.

### How does Force Register work

When promoting a schema to a higher environment in Klaw, you can use the **Force Register Schema** option, which enables
you to register a schema that may not be compatible with previous schemas. By selecting this option, Klaw will change
the compatibility of the subject (topic) to **NONE**, register the new schema, and revert to the previous subject
compatibility. If the subject compatibility is not set, it will fall back to global compatibility. However, Klaw will
not change the global compatibility.

:::note
Requests cannot be approved by the user who raised it. It must be approved by a different user from the same team.
- [Promote a topic](../HowTo/topics/Promote-a-topic.md)
- [Promote a schema](../HowTo/schemas/Promote-a-schema.md)
15 changes: 10 additions & 5 deletions docs/HowTo/schemas/Promote-a-schema.md
Original file line number Diff line number Diff line change
@@ -1,31 +1,36 @@
# Promote a Schema
# Promote a schema

Schema promotion is a key feature of Klaw that improves governance,
Promotion is a key feature of Klaw that improves governance,
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)

## Prerequisites

Before using this functionality, the Superadmin must ensure that all
prerequisites are met. For more information, see
[Promotion](../../Concepts/promotion.md).

## Schema promotion
## Schema promotion step by step

After creating a schema in the base environment, you can promote it to
the next environment for better governance, administration, and control.
This involves submitting a promotion request that your teammates can
review and either approve or decline.

In the **Topic overview**, you can request and view the schema for an individual topic.
Release 2.0.0 allows you to promote existing schemas to higher-level environments.
To do this, select the specific schema version you want to promote from the lower environment to the higher environment.

You can see all created schema environments in the same **Topic overview
-\> Schemas** tab where you can initiate schema promotion.

To promote a schema to a higher environment, follow these steps:

1. Select _Topics_ on the navigation bar.
2. Select the specific Apache Kafka topic you wish to promote a Schema to the
higher environment.
2. Select the Apache Kafka topic for which you wish to promote the schema to the next environment.
3. Select the **Schema** tab under the main topic section.
4. Select the **Promote to \[Next Environment\]** button to promote the
schema to a higher environment, provided the higher environment has
Expand Down
47 changes: 23 additions & 24 deletions docs/HowTo/topics/Promote-a-topic.md
Original file line number Diff line number Diff line change
@@ -1,34 +1,33 @@
# Promote a topic

Promotion is one of the core features of Klaw and allows better
governance, administration, and control of topics. It ensures a topic
can be created in the lowest environment and then promoted to higher
environments as required.
Promotion is a key feature of Klaw that improves governance,
administration, and control of topics. With topic promotion, a topic
can be initially created in the lowest environment and then promoted to
higher environments as needed.

Learn more: [Concepts—Promotion](../../Concepts/promotion.md)

## Prerequisites

The Superadmin must ensure all prerequisites are met before this
functionality is used see
[Promotion](../../Concepts/promotion.md)
[Concepts—Promotion](../../Concepts/promotion.md)

## Topic promotion

Once a topic is created in the base environment, it is possible to
promote this to the next environment. This will create a promotion
request that the requester's teammates can review, approve, or decline.
Each created environment can be seen in the same **Topic overview**
where the topic can be promoted.

To promote a topic, follow these steps:

1. In Klaw, select **Topics** on the navigation bar.
2. Select the specific Apache Kafka topic you wish to promote to the higher
environment.
3. Click the **Promote to \[Next Environment\]** button to promote the
topic to the next environment.
4. Configure the number of Partitions and Replication Factor for the
higher environment in the drop-downs provided.
5. Click **Submit Promotion to \[Next Environment\]** to confirm the
promotion to the next environment.
6. A topic request is now created for team members to review and
approve under **Approvals** view.
Once a topic is created in the base environment, you can promote it to the next higher-level environment. This will
create a promotion request that your teammates can review, approve, or decline. The **Topic overview** view will show
all the environments the topic is configured on, including the environment to which you can promote the topic.

## Topic promotion step by step

To promote a topic to a higher environment, follow these steps:

1. Select **Topics** on the navigation bar.
2. Select the specific Apache Kafka topic you want to promote to the higher environment.
3. Select the **Promote to \[Next Environment\]** button to promote the topic to the next environment (higher
environment) that has been configured.
4. Configure the number of **Partitions** and **Replication factor** for the higher environment in the dropdowns
provided.
5. Confirm the promotion to the next environment by selecting **Submit Promotion to \[Next Environment\]**
6. A topic request is now created for team members to review and approve under **Approvals**.

0 comments on commit cf5ebc5

Please sign in to comment.