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

docs: Add operation sections, move telemetry status docu #423

Merged
merged 7 commits into from
Sep 27, 2023

Conversation

a-thaler
Copy link
Collaborator

Description

Changes proposed in this pull request:

  • Add operation section for the 3 domain outlining the different metrics to observe
  • Moved status documentation of telemetry resource into the relevant document
  • Provided missing telemetry status API docs

Related Issues and Documents

Closes:

Related issues:

Traceability

  • The PR is linked to a GitHub Issue.
  • New features have a milestone label set.
  • New features have defined acceptance criteria in a corresponding GitHub Issue, and all criteria are satisfied with this PR.
  • The corresponding GitHub Issue has a respective area label.
  • The follow-up issues (if any) are linked in the Related Issues section.

Testability

The feature is unit-tested:

  • Yes.
  • No, because unit tests are not needed.
  • No, because of ...

The feature is e2e-tested:

  • Yes.
  • No, because e2e-tests are not needed.
  • No, because of ...

Tests conducted for the PR:

Codebase

  • My code follows the Effective Go style guidelines.
  • The code was planned and designed following the defined architecture and the separation of concerns.
  • The code has sufficient comments, particularly for all hard-to-understand areas.
  • This PR adds value and shows no feature creep.
  • I have augmented the test suite that proves my fix is effective or that my feature works.
  • Adjusted the documentation if the change is user-facing.

@kyma-bot kyma-bot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Sep 21, 2023
@kyma-bot
Copy link
Contributor

Skipping CI for Draft Pull Request.
If you want CI signal for your change, please convert it to an actual PR.
You can still manually trigger a test run with /test all

@kyma-bot kyma-bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Sep 21, 2023
@a-thaler a-thaler changed the title docu: Add operation sections, move telemetry status docu docs: Add operation sections, move telemetry status docu Sep 21, 2023
@a-thaler a-thaler added area/documentation Documentation changes kind/feature Categorizes issue or PR as related to a new feature. labels Sep 21, 2023
@a-thaler a-thaler marked this pull request as ready for review September 22, 2023 07:44
@a-thaler a-thaler requested review from a team as code owners September 22, 2023 07:44
@kyma-bot kyma-bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Sep 22, 2023
@a-thaler
Copy link
Collaborator Author

/retest

chrkl
chrkl previously approved these changes Sep 22, 2023
@kyma-bot kyma-bot added the lgtm Looks good to me! label Sep 22, 2023
@kyma-bot kyma-bot removed the lgtm Looks good to me! label Sep 22, 2023
@a-thaler
Copy link
Collaborator Author

/retest

chrkl
chrkl previously approved these changes Sep 25, 2023
@kyma-bot kyma-bot added the lgtm Looks good to me! label Sep 25, 2023
docs/user/02-logs.md Outdated Show resolved Hide resolved
docs/user/02-logs.md Outdated Show resolved Hide resolved
docs/user/02-logs.md Outdated Show resolved Hide resolved
docs/user/02-logs.md Outdated Show resolved Hide resolved
docs/user/03-traces.md Outdated Show resolved Hide resolved
docs/user/03-traces.md Outdated Show resolved Hide resolved
docs/user/04-metrics.md Outdated Show resolved Hide resolved
docs/user/04-metrics.md Outdated Show resolved Hide resolved
docs/user/04-metrics.md Outdated Show resolved Hide resolved
docs/user/04-metrics.md Outdated Show resolved Hide resolved
@kyma-bot kyma-bot removed the lgtm Looks good to me! label Sep 26, 2023
NHingerl
NHingerl previously approved these changes Sep 26, 2023
@kyma-bot kyma-bot added the lgtm Looks good to me! label Sep 26, 2023
@kyma-bot kyma-bot added the lgtm Looks good to me! label Sep 27, 2023
@a-thaler
Copy link
Collaborator Author

/retest

@kyma-bot kyma-bot merged commit deb3610 into kyma-project:main Sep 27, 2023
2 checks passed
@a-thaler a-thaler deleted the docu branch September 27, 2023 11:23
@a-thaler a-thaler added this to the 1.1.0 milestone Oct 4, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation Documentation changes kind/feature Categorizes issue or PR as related to a new feature. lgtm Looks good to me! size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants