-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
refactor: split content for promotion (#164)
* 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
1 parent
241006e
commit cf5ebc5
Showing
3 changed files
with
36 additions
and
79 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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**. |