Skip to content

Commit

Permalink
fix typos and wording
Browse files Browse the repository at this point in the history
  • Loading branch information
FilipRudy committed Feb 27, 2025
1 parent c41370b commit 3fcab82
Show file tree
Hide file tree
Showing 5 changed files with 28 additions and 27 deletions.
16 changes: 8 additions & 8 deletions docs/user/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,19 @@

## What is Kyma CLI?

The Kyma CLI is a command line interface tool designed to simplify usage of the Kyma ecosystem. It allows developers and administrators to manage Kyma modules and applications, deploy simple applications, and many more. By using Kyma CLI, users can perform complex tasks with simple commands, accelerating development cycles.
The Kyma CLI is a command-line interface tool designed to simplify the use of the Kyma ecosystem. It allows you to manage Kyma modules and applications, deploy simple applications, and more. With Kyma CLI, you can perform complex tasks with simple commands, accelerating development cycles.

With Kyma CLI, you can build, push, and deploy, an application to a Kyma cluster with a single command. It automatically detects the Dockerfile in the current directory, builds and pushes the image to the in-cluster registry, and applies the necessary Kubernetes resources.
In addition, you can build, push, and deploy, an application to a Kyma cluster with a single command. It automatically detects the Dockerfile in the current directory, builds and pushes the image to the in-cluster registry, and applies the necessary Kubernetes resources.

Kyma CLI also provides a set of commands to manage Kyma modules efficiently. Users can manage, deploy and configure modules seamlessly. The Kyma CLI module commands allow users to list available and installed modules, enable or disable them, and configure their settings. Modules can be deployed with default or custom configuration.
Kyma CLI also provides a set of commands to manage Kyma modules efficiently. You can manage, deploy, and configure modules seamlessly. With Kyma CLI module commands, you can list available and installed modules, add or delete them, and configure their settings. Modules can be deployed with the default or custom configuration.
## Features
The Kyma CLI provides the following features:

- Simplified module management
- Automated deployments
- Built-in extensibility
- Integrated service management
- Commands providing useful automation
- Simplified module management.
- Automated deployments.
- Built-in extensibility.
- Integrated service management.
- Commands providing useful automation.

## Related Information

Expand Down
4 changes: 2 additions & 2 deletions docs/user/_sidebar.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@
* [Back to Kyma Home](/)
* [Kyma CLI](README.md)
* [Tutorials](tutorials/README.md)
* [Add or Delete Modules](tutorials/01-10-add-delete-modules)
* [Manage and Unmanage Modules](tutorials/01-11-manage-unmanage-modules)
* [Adding and Deleting a Kyma Module Using Kyma CLI](tutorials/01-10-add-delete-modules)
* [Setting Your Module to the Managed and Unmanaged State in Kyma CLI](tutorials/01-11-manage-unmanage-modules)
<!-- markdown-link-check-enable -->
19 changes: 10 additions & 9 deletions docs/user/tutorials/01-10-add-delete-modules.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,28 @@
# Adding a new Module using Kyma CLI
This tutorial shows how you can add a new Module using Kyma CLI.
# Adding and Deleting a Kyma Module Using Kyma CLI
This tutorial shows how you can add a new module using Kyma CLI.

Keep in mind that Modules added without any specified form of CR have the policy field set to Ignore.
## Steps
> [!WARNING]
> Modules added without any specified form of the custom resource have the policy field set to `Ignore`.
## Procedure

### Adding a new module
### Adding a New Module

1. To add a new Module with the default policy set to `CreateAndDelete`, use the command below:
1. To add a new module with the default policy set to `CreateAndDelete`, use the following command:

```
kyma alpha module add {MODULE-NAME} --default-cr
```
2. If you would like to add a Module with a different CR, use the `--cr-path={CR-FILEPATH}` flag, as shown below:
2. To add a module with a different CR, use the `--cr-path={CR-FILEPATH}` flag:
```
kyma alpha module add {MODULE-NAME} --cr-path={CR-PATH-FILEPATH}
```
3. You can also specify which channel the Module should use with the `-c {CHANNEL-NAME}` flag, as shown below:
3. You can also specify which channel the module should use with the `-c {CHANNEL-NAME}` flag:
```
kyma alpha module add {MODULE-NAME} -c {CHANNEL-NAME} --default-cr
```
### Deleting an existing module
1. To delete an existing module, use the command below:
1. To delete an existing module, use the following command:
```
kyma alpha module delete {MODULE-NAME}
Expand Down
14 changes: 7 additions & 7 deletions docs/user/tutorials/01-11-manage-unmanage-modules.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,32 @@
# Setting Your Module to the Managed/Unmanaged State in Kyma CLI
# Setting Your Module to the Managed and Unmanaged State in Kyma CLI

In some cases, for example, for testing, you may need to modify your module beyond what is supported by its configuration. By default, when a module is in the managed state, Kyma Control Plane governs its Kubernetes resources, reverting any manual changes during the next reconciliation loop.

To modify Kubernetes objects directly without them being reverted, you must set the module to the unmanaged state. In this state, reconciliation is disabled, ensuring your manual changes are preserved.

> [!CAUTION]
> Setting your module to the Unmanaged state may lead to instability and data loss within your cluster. It may also be impossible to revert the changes. In addition, we don't guarantee any service level agreement (SLA) or provide updates and maintenance for the module.
> Setting your module to the unmanaged state may lead to instability and data loss within your cluster. It may also be impossible to revert the changes. In addition, we don't guarantee any service level agreement (SLA) or provide updates and maintenance for the module.

## Steps
## Procedure

### Setting a Module to the Managed State


1. To set Module to the Managed state, use the command below:
1. To set a module to the managed state, use the following command:

```
kyma alpha module manage {MODULE-NAME}
```
2. Even if the Module is already Managed, you can change it's policy by adding optional flag ``--policy {POLICY-NAME}``. The default policy is ``CreateAndDelete``.
2. Even if the module is already in the managed state, you can change its policy by adding the optional flag ``--policy {POLICY-NAME}``. The default policy is ``CreateAndDelete``.
### Setting a Module to the Unmanaged State
1. To set Module to the Unmanaged state, use the command below:
1. To set a module to the unmanaged state, use the following command::
```
kyma alpha module unmanage {MODULE-NAME}
```
> [!CAUTION]
> Depending on the introduced changes, bringing back the module to the Managed state might not be possible.
> Depending on the introduced changes, bringing back the module to the managed state might not be possible.
2 changes: 1 addition & 1 deletion docs/user/tutorials/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Tutorials

This section will help you understand how Kyma CLI and how to use it in different scenarios.
This section will help you understand Kyma CLI and how to use it in different scenarios.

0 comments on commit 3fcab82

Please sign in to comment.