Skip to content

Add otel-trace-context to the configmap docs - #2273

Open
javorszky wants to merge 3 commits into
nic-release-5.7from
nic/otel-trace-context
Open

Add otel-trace-context to the configmap docs#2273
javorszky wants to merge 3 commits into
nic-release-5.7from
nic/otel-trace-context

Conversation

@javorszky

Copy link
Copy Markdown
Contributor

Proposed changes

This is the documentation that goes with nginx/kubernetes-ingress#10843

Adds the otel-trace-context configmap option's documentation.

Tested locally with make watch, looks good.

Checklist

Before sharing this pull request, I completed the following checklist:

Footnotes

  1. Potentially sensitive information includes personally identify information (PII), authentication credentials, and live URLs. Refer to the style guide for guidance about placeholder content.

@javorszky
javorszky requested a review from a team as a code owner September 10, 2026 15:40
@github-actions github-actions Bot added documentation Improvements or additions to documentation product/nic Issues related to NGINX Ingress Controller labels Sep 10, 2026
@github-actions

Copy link
Copy Markdown

Deploy Preview will be available once build job completes!

Name Link
😎 Deploy Preview https://frontdoor-test-docs.nginx.com/previews/docs/2273/

@javorszky
javorszky changed the base branch from nic-release-5.6.2 to nic-release-5.7 September 10, 2026 15:44

@promptless promptless Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Promptless style review

Thanks for adding this, @javorszky. The row lands in the right place next to the other otel-* keys, links to the upstream otel_trace_context directive, and lists all four accepted values correctly. I checked it against the implementing change (nginx/kubernetes-ingress#10843) and the key name, the required otel-exporter-endpoint dependency, and the value set all match.

Style: No blocking style issues. One minor consistency nit: the description cell doesn't end with a period, while the sibling rows do. Consider adding one after ignore (cite: tables — parallel structure within a column).

Technical accuracy (listed separately for SME verification): See the inline comment on the Default column value. I don't correct technical content myself. Please confirm it with a subject matter expert.

Categories checked in full: voice-and-tone, grammar, punctuation, formatting (tables, italics, capitalization), terminology (word-list, f5-product-names). Skipped: accessibility, media, error-messages, security. The change adds no image, error string, or sensitive data.

Reading level: The added row is a short reference entry, well within the target reading level. No complexity concerns.

Submitting as a comment rather than an approval only because of the technical-accuracy question above. That's a call for the maintainer, not a blocker.

Comment thread content/nic/configuration/global-configuration/configmap-resource.md Outdated
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation product/nic Issues related to NGINX Ingress Controller

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants