chore: improve config docs gen #426
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
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. |
| 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.
| 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: "" |
Copilot uses AI. Check for mistakes.
| # 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.
| # 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: "" |
Copilot uses AI. Check for mistakes.
…proved clarity and structure
…guration documentation
|
Merging as I want to create a guide and I need the config. |
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.