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 73dc565 commit 6c976bd
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 9 deletions.
2 changes: 1 addition & 1 deletion docs/user/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

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.

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.
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. 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
Expand Down
11 changes: 6 additions & 5 deletions docs/user/tutorials/01-10-add-delete-modules.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,29 @@
# Adding and Deleting a Kyma Module Using Kyma CLI
This tutorial shows how you can add a new module using Kyma CLI.
This tutorial shows how you can add and delete a new module using Kyma CLI.

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

### Adding a New Module

1. To add a new module with the default policy set to `CreateAndDelete`, use the following command:
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. To add a module with a different CR, use the `--cr-path={CR-FILEPATH}` flag:
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:

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 following command:
To delete an existing module, use the following command:

```
kyma alpha module delete {MODULE-NAME}
Expand Down
6 changes: 3 additions & 3 deletions docs/user/tutorials/01-11-manage-unmanage-modules.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,16 +13,16 @@ To modify Kubernetes objects directly without them being reverted, you must set
### Setting a Module to the Managed State


1. To set a module to the managed state, use the following command:
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 in the managed state, you can change its policy by adding the optional flag ``--policy {POLICY-NAME}``. The default policy is ``CreateAndDelete``.
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 a module to the unmanaged state, use the following command::
To set a module to the unmanaged state, use the following command:

```
kyma alpha module unmanage {MODULE-NAME}
Expand Down

0 comments on commit 6c976bd

Please sign in to comment.