Open
Conversation
Signed-off-by: Attila Mészáros <a_meszaros@apple.com>
Signed-off-by: Attila Mészáros <a_meszaros@apple.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
Introduces a new Operations documentation section and reorganizes existing content by moving MDC logging documentation into that section while refocusing the former “Observability” page on metrics.
Changes:
- Added an Operations section with new pages for Helm chart usage and logging/MDC.
- Removed MDC logging content from
observability.mdand renamed that page’s title to “Metrics”. - Updated documentation landing page navigation and adjusted page weights for ordering.
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/content/en/docs/documentation/operations/_index.md | Adds the Operations section landing page. |
| docs/content/en/docs/documentation/operations/helm-chart.md | Documents the generic Helm chart and how to configure/use it. |
| docs/content/en/docs/documentation/operations/logging.md | Adds dedicated logging/MDC documentation (moved out of the old page). |
| docs/content/en/docs/documentation/observability.md | Removes MDC logging section and shifts page identity toward metrics. |
| docs/content/en/docs/documentation/configuration.md | Adjusts nav weight to reflect the updated sidebar ordering. |
| docs/content/en/docs/documentation/_index.md | Updates the top-level documentation navigation to point to Operations. |
Comment on lines
+12
to
+20
| | MDC Key | Value added from primary resource | | ||
| |:---------------------------|:----------------------------------| | ||
| | `resource.apiVersion` | `.apiVersion` | | ||
| | `resource.kind` | `.kind` | | ||
| | `resource.name` | `.metadata.name` | | ||
| | `resource.namespace` | `.metadata.namespace` | | ||
| | `resource.resourceVersion` | `.metadata.resourceVersion` | | ||
| | `resource.generation` | `.metadata.generation` | | ||
| | `resource.uid` | `.metadata.uid` | |
There was a problem hiding this comment.
The table rows start with || instead of a single |. Many Markdown renderers (and Hugo Markdown configurations) expect | ... | ... | and may not render this as a table. Use a single leading pipe per row (e.g., | MDC Key | ... |) for consistent rendering.
Comment on lines
+31
to
+39
| | MDC Key | Value from Resource from the Event | | ||
| |:-----------------------------------------------|:-------------------------------------------------| | ||
| | `eventsource.event.resource.name` | `.metadata.name` | | ||
| | `eventsource.event.resource.uid` | `.metadata.uid` | | ||
| | `eventsource.event.resource.namespace` | `.metadata.namespace` | | ||
| | `eventsource.event.resource.kind` | resource kind | | ||
| | `eventsource.event.resource.resourceVersion` | `.metadata.resourceVersion` | | ||
| | `eventsource.event.action` | action name (e.g. `ADDED`, `UPDATED`, `DELETED`) | | ||
| | `eventsource.name` | name of the event source | |
There was a problem hiding this comment.
Same issue as above: || is non-standard for Markdown tables and may break rendering. Switch these rows to start with a single |.
This file contains hidden or 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
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.
No description provided.