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

[Restricted Markets] Provide monitoring docs #2080

Open
6 tasks
mmitoraj opened this issue Nov 29, 2024 · 0 comments · May be fixed by #2203
Open
6 tasks

[Restricted Markets] Provide monitoring docs #2080

mmitoraj opened this issue Nov 29, 2024 · 0 comments · May be fixed by #2203
Assignees
Labels
area/documentation Issues or PRs related to documentation

Comments

@mmitoraj
Copy link
Contributor

mmitoraj commented Nov 29, 2024

Description

Lifecycle Manager is one of the core components shipped for the multiple Control Plane epic that must be officially documented in SAP BTP, Partner-Managed Edition.

As one of the docu elements, we need to provide the observability docu for Lifecycle Manager. It should include monitoring docs with metrics description

Reasons

We must deliver user documentation regarding Lifecycle Manager for the NS2 operator.

Acceptance Criteria

  • Create the folder structure (if it doesn't exist yet) based on the /template-repository example and the /operator folder structure
  • Go through the existing documentation and check if it can be re-used
  • Document Lifecycle Manager's monitoring and metrics
    • Index of metrics prepared, with a short description for each of them
    • List of dashboards prepared
  • Create a follow-up issue on the automation of the documentation sync

Assignees

@kyma-project/technical-writers
@kyma-project/jellyfish

Attachments

@mmitoraj mmitoraj added the area/documentation Issues or PRs related to documentation label Nov 29, 2024
@nesmabadr nesmabadr self-assigned this Jan 22, 2025
@nesmabadr nesmabadr linked a pull request Jan 23, 2025 that will close this issue
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

Successfully merging a pull request may close this issue.

2 participants