Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Unify CRs' descriptions in Busola #18321

Closed
nataliasitko opened this issue Oct 19, 2023 · 6 comments
Closed

Unify CRs' descriptions in Busola #18321

nataliasitko opened this issue Oct 19, 2023 · 6 comments
Labels
area/documentation Issues or PRs related to documentation

Comments

@nataliasitko
Copy link
Contributor

nataliasitko commented Oct 19, 2023

Description

There are multiple versions of a CR description in Busola. TWs should agree on one version and use it for all the modules.

Use the following versions (to be discussed):

status current description updated description link to the code
Istio CR describes the Istio module Istio custom resource configures the Istio module. https://github.com/kyma-project/istio/blob/main/config/ui-extensions/istios/general#L14
Keda CR configures keda installation. Keda custom resource configures the Keda module. https://github.com/kyma-project/istio/blob/main/config/ui-extensions/istios/general#L14
Kyma Custom Resource represents Kyma installation in a cluster. Kyma custom resource represents Kyma installation in a cluster. https://github.com/kyma-project/kyma-dashboard/blob/main/extensions/kyma/kyma.yaml#L120
ModuleTemplate Custom Resource contains modules' metadata with links to their images and manifests. ModuleTemplate custom resource contains modules' metadata with links to their images and manifests. https://github.com/kyma-project/kyma-dashboard/blob/main/extensions/kyma/moduleTemplate.yaml#L48
NATS CR specifies NATS module. NATS custom resource configures the NATS module. https://github.com/kyma-project/nats-manager/blob/main/config/ui-extensions/nats/general#L14
Serverless CR specifies serverless module. Serverless custom resource configures the Serverless module. https://github.com/kyma-project/serverless-manager/blob/main/config/operator/ui-extensions/serverless/general#L14
The Telemetry resource configures the telemetry module.
(the link leads to the website)
Telemetry custom resource configures the Telemetry module. https://github.com/kyma-project/telemetry-manager/blob/main/config/busola/telemetry_busola_extension_cm.yaml#L110
See the description of the APIGateway custom resource. APIGateway custom resource configures the API Gateway module. https://github.com/kyma-project/api-gateway/blob/main/config/ui-extensions/apigateways/general#L14
ApplicationConnector custom resource configures the Application Connector module.
Eventing custom resource configures the Eventing module.

Area

  • UI

Reasons

  • improve the user experience, ensure consistency in the user interface texts

Assignees

@kyma-project/technical-writers

Attachments

Screenshot 2023-10-19 at 14 24 07
@nataliasitko nataliasitko added the area/documentation Issues or PRs related to documentation label Oct 19, 2023
@nataliasitko nataliasitko changed the title Ensure that custom resources' descriptions similar for all the Kyma modules Ensure that custom resources' descriptions are similar for all the Kyma modules Oct 19, 2023
@nataliasitko nataliasitko changed the title Ensure that custom resources' descriptions are similar for all the Kyma modules Unify CRs' descriptions in Busola Oct 20, 2023
@NHingerl
Copy link
Contributor

I like the proposal!

@kyma-bot
Copy link
Contributor

This issue or PR has been automatically marked as stale due to the lack of recent activity.
Thank you for your contributions.

This bot triages issues and PRs according to the following rules:

  • After 60d of inactivity, lifecycle/stale is applied
  • After 7d of inactivity since lifecycle/stale was applied, the issue is closed

You can:

  • Mark this issue or PR as fresh with /remove-lifecycle stale
  • Close this issue or PR with /close

If you think that I work incorrectly, kindly raise an issue with the problem.

/lifecycle stale

@kyma-bot kyma-bot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Dec 22, 2023
@nataliasitko nataliasitko removed the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Dec 27, 2023
Copy link

This issue has been automatically marked as stale due to the lack of recent activity. It will soon be closed if no further activity occurs.
Thank you for your contributions.

@github-actions github-actions bot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Feb 26, 2024
@grego952 grego952 removed the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Feb 26, 2024
@mmitoraj
Copy link
Contributor

Kyma custom resource represents Kyma installation in a cluster. -change to Kyma custom resource configures your Kyma modules

@mmitoraj
Copy link
Contributor

ModuleTemplate Custom Resource - file not found

@mmitoraj
Copy link
Contributor

In the new CRs' descriptions, we link to the kyma-project.io user documentation about each resource.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation Issues or PRs related to documentation
Projects
None yet
Development

No branches or pull requests

5 participants