chore: improve config docs gen #426
Merged
Conversation
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
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR improves the configuration documentation and code generation by standardizing the YAML structure and enhancing inline guidance.
- Updates configuration tables to remove extra commentary and add concise "Required" markers.
- Enhances YAML documentation for various configuration sections including alerts, message queues, and OpenTelemetry settings.
- Adds a Makefile target to generate configuration docs.
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| docs/pages/references/configuration.mdx | Standardizes YAML comments and configuration key documentation. |
| Makefile | Adds a new target to generate configuration docs. |
Comment on lines
309
to
314
| exporter: "" | ||
|
|
||
| # Specifies the OTLP exporter to use for this telemetry type (e.g., 'otlp'). Typically used with environment variables like OTEL_EXPORTER_OTLP_TRACES_ENDPOINT. | ||
| # Required: C | ||
| exporter: "" | ||
|
|
There was a problem hiding this comment.
Duplicate 'exporter' keys found in the 'otel.logs' section can lead to unintended configuration overrides; please consolidate them into a single key.
Suggested change
| exporter: "" | |
| # Specifies the OTLP exporter to use for this telemetry type (e.g., 'otlp'). Typically used with environment variables like OTEL_EXPORTER_OTLP_TRACES_ENDPOINT. | |
| # Required: C | |
| exporter: "" |
Comment on lines
319
to
327
| # Specifies the OTLP protocol ('grpc' or 'http') for this telemetry type. Typically used with environment variables like OTEL_EXPORTER_OTLP_TRACES_PROTOCOL. | ||
| # Required: C | ||
| protocol: "" | ||
|
|
||
| # Specifies the OTLP protocol ('grpc' or 'http') for this telemetry type. Typically used with environment variables like OTEL_EXPORTER_OTLP_TRACES_PROTOCOL. | ||
| # Required: C | ||
| protocol: "" | ||
|
|
||
|
|
There was a problem hiding this comment.
Multiple 'protocol' keys in the 'otel.logs' section may cause ambiguity in configuration; consider removing the redundant declarations.
Suggested change
| # Specifies the OTLP protocol ('grpc' or 'http') for this telemetry type. Typically used with environment variables like OTEL_EXPORTER_OTLP_TRACES_PROTOCOL. | |
| # Required: C | |
| protocol: "" | |
| # Specifies the OTLP protocol ('grpc' or 'http') for this telemetry type. Typically used with environment variables like OTEL_EXPORTER_OTLP_TRACES_PROTOCOL. | |
| # Required: C | |
| protocol: "" |
…proved clarity and structure
…guration documentation
Collaborator
Author
|
Merging as I want to create a guide and I need the config. |
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.
Implements #415
@alexluong - I noticed that the Azure update highlighted the brittle nature of the existing codegen. So, I've taken your suggestions and added it in this PR.