Conversation
Signed-off-by: Attila Mészáros <a_meszaros@apple.com>
Signed-off-by: Attila Mészáros <a_meszaros@apple.com>
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. |
| | 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.
| | 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 |.
|
|
||
| ### MDC entries during event handling | ||
|
|
||
| Although, usually users might not require it in their day-to-day workflow, it is worth mentioning that |
There was a problem hiding this comment.
Remove the comma after 'Although' for correct grammar.
| Although, usually users might not require it in their day-to-day workflow, it is worth mentioning that | |
| Although usually users might not require it in their day-to-day workflow, it is worth mentioning that |
| - **[Eventing](eventing/)** - Understanding the event-driven model | ||
| - **[Accessing Resources in Caches](working-with-es-caches/)** - How to access resources in caches | ||
| - **[Observability](observability/)** - Monitoring and debugging your operators | ||
| - **[Operations](operations/)** - Helm chart, metrics, and logging |
There was a problem hiding this comment.
This navigation description says Operations includes “metrics”, but this PR adds only operations/helm-chart.md and operations/logging.md while metrics content remains in documentation/observability.md (retitled to “Metrics”). Either add/move a metrics page under operations/, or adjust this description to match what’s actually in the Operations section.
| - **[Operations](operations/)** - Helm chart, metrics, and logging | |
| - **[Operations](operations/)** - Helm chart and logging |
No description provided.