feat: Update docs about recent changes related to kyma-dashboard #3347
Conversation
kyma-bot
added
the
do-not-merge/work-in-progress
|
Skipping CI for Draft Pull Request. |
kyma-bot
added
the
size/L
dbadura
requested review from
a team,
akucharska,
mrCherry97,
chriskari and
OliwiaGowor
as code owners
kyma-bot
removed
the
do-not-merge/work-in-progress
kyma/README.md
Outdated
| > **NOTE:** This is a general template that you can use for a project README.md. Except for the mandatory sections, use only those sections that suit your use case but keep the proposed section order. | ||
| > | ||
| > Mandatory sections: | ||
| > - `Overview` | ||
| > - `Prerequisites`, if there are any requirements regarding hard- or software | ||
| > - `Installation` | ||
| > - `Contributing` - do not change this! | ||
| > - `Code of Conduct` - do not change this! | ||
| > - `Licensing` - do not change this! |
There was a problem hiding this comment.
| > **NOTE:** This is a general template that you can use for a project README.md. Except for the mandatory sections, use only those sections that suit your use case but keep the proposed section order. | |
| > | |
| > Mandatory sections: | |
| > - `Overview` | |
| > - `Prerequisites`, if there are any requirements regarding hard- or software | |
| > - `Installation` | |
| > - `Contributing` - do not change this! | |
| > - `Code of Conduct` - do not change this! | |
| > - `Licensing` - do not change this! |
kyma/README.md
Outdated
| - [`npm`](https://www.npmjs.com/) in version 8.1.2 or higher | ||
| - [`node`](https://nodejs.org/en/) in version 16.13.2 or higher |
There was a problem hiding this comment.
Here we should have the same versions as for busola
kyma-bot
added
size/M
README.md
Outdated
| When the `ENVIRONMENT` is set to `my-env`, the busola looks for custom configuration in **public/environemnt/my-env** | ||
| If the `ENVIRONMENT` is not set busola fetch default configuration which has the same structure as custom configuration located in [public](./public) | ||
|
|
||
| In case of docker image, the file `active.env` is created from `ENVIRONMENT` env at the startup to image. |
There was a problem hiding this comment.
| In case of docker image, the file `active.env` is created from `ENVIRONMENT` env at the startup to image. | |
| In the case of the Docker image, the `active.env` file is created from the **ENVIRONMENT** env at the startup of the image. |
There was a problem hiding this comment.
Again, I'm not sure if I understand it correctly. What is "env" here? If it's environment, is it necessary to say "ENVIRONMENT environment"?
There was a problem hiding this comment.
env is a shortcut of environment variable which is represented by KEY=value, so to make it more readable I used env. Additionaly it's quite common to name it like that.
There was a problem hiding this comment.
If it's not the actual value, I recommend rephrasing it to:
In the case of the Docker image, the active.env file is created at the startup of the image from the environment specified in the ENVIRONMENT variable.
Co-authored-by: Iwona Langer <[email protected]>
kyma-bot
added
size/L
Co-authored-by: Iwona Langer <[email protected]>
|
/override tide |
|
@mrCherry97: Overrode contexts on behalf of mrCherry97: tide In response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. |
Description
Changes proposed in this pull request:
Related issue(s)
#3298
Definition of done
backlog#4567