docs: Metrics configuration guide & FAQ reorg #2414
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Anna Kapuscinska <[email protected]>
lambdanis
added
area/documentation
lambdanis
force-pushed
the
pr/lambdanis/docs-metrics
branch
2 times, most recently
from
ae4c47d to
f505272
Compare
The FAQ page included some installation and some CI questions. They have different audiences, so let's split them: * Installation questions are under "Installation and Configuration" section * CI questions are a part of "Submitting a pull request" page Signed-off-by: Anna Kapuscinska <[email protected]>
This is a general rewrite of the Metrics page. The page is moved from the "Concepts" section to "Installation and Configuration" - it barely touches on the concept of metrics, but it does guide the use through the metrics configuration, so it makes more sense there. The page covers: * The purpose of metrics and a link to the metrics reference * How to enable/disable metrics in a Kubernetes and non-Kubernetes deployments * How to verify that metrics are exposed * How to configure labels on events metrics * How to enable ServiceMonitor and scrape metrics Signed-off-by: Anna Kapuscinska <[email protected]>
lambdanis
force-pushed
the
pr/lambdanis/docs-metrics
branch
from
f505272 to
06f8058
Compare
✅ Deploy Preview for tetragon ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
|
The CI is failing because https://tetragon.cilium.io/docs/installation/faq/ doesn't exist yet, but it will after this PR is merged. |
mtardy
reviewed
May 16, 2024
| description: "List of frequently asked questions" | ||
| aliases: ["/docs/faq"] |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The main thing here is a general rewrite of the Metrics page.
The page is moved from the "Concepts" section to "Installation and
Configuration" - it barely touches on the concept of metrics, but it does guide
the user through the metrics configuration, so it makes more sense there.
The page covers:
I also did a small reorg of the installation docs. The "Installation" section is renamed to "Installation and Configuration", and the FAQ page is moved there. Two CI-related FAQ questions are moved under the Contribution Guide.
To avoid breaking links I also introduced aliases: docs/concepts/metrics -> docs/installation/metrics and docs/faq -> docs/installation/faq.