Skip to content

[chore] Perform textlint corrections#3747

Open
thompson-tomo wants to merge 8 commits into
open-telemetry:mainfrom
thompson-tomo:textlint_fixes
Open

[chore] Perform textlint corrections#3747
thompson-tomo wants to merge 8 commits into
open-telemetry:mainfrom
thompson-tomo:textlint_fixes

Conversation

@thompson-tomo

@thompson-tomo thompson-tomo commented May 26, 2026

Copy link
Copy Markdown
Contributor

Progresses #3036

Changes

This performs the corrections for issues identified by textlint with the key one's being:

  • id -> ID
  • client side -> client-side
  • various casing tweaks

All changes have been automated using the tool with the exception of adding briefs to only the enums requiring it so that the docs can pass. This tool will be added via seperate PR aka #3578

Important

Pull requests acceptance are subject to the triage process as described in Issue and PR Triage Management.
PRs that do not follow the guidance above, may be automatically rejected and closed.

Merge requirement checklist

  • CONTRIBUTING.md guidelines followed.
  • Change log entry added, according to the guidelines in When to add a changelog entry.
    • If your PR does not need a change log, start the PR title with [chore]
  • Links to the prototypes or existing instrumentations (when adding or changing conventions)

@github-actions

Copy link
Copy Markdown

This PR has been labeled as stale due to lack of activity. It will be automatically closed if there is no further activity over the next 7 days.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

This PR applies automated textlint-driven editorial corrections across the semantic convention YAML model and the generated/handwritten documentation, primarily standardizing casing (e.g., “ID”, “URL”), hyphenation (e.g., “client-side”), and similar wording tweaks. It also adds missing brief fields to specific enum members so docs generation passes.

Changes:

  • Apply textlint corrections across model/ YAML and docs/ Markdown.
  • Add brief fields to selected enum members (e.g., TLS protocol name, telemetry SDK language) to satisfy documentation generation requirements.
  • Update a small internal script and area table wording for consistency (“bug fixes”, “bug fix”).

Reviewed changes

Copilot reviewed 143 out of 154 changed files in this pull request and generated 6 comments.

Show a summary per file
File Description
model/user-agent/registry.yaml Example formatting adjusted.
model/url/registry.yaml URL/filename wording and casing fixes.
model/tls/registry.yaml Add enum member briefs (SSL/TLS).
model/telemetry/registry.yaml Add enum member briefs (language names).
model/system/metrics.yaml UNIX/CPU casing tweaks in briefs.
model/source/registry.yaml UNIX casing tweak in brief.
model/session/registry.yaml “ID” casing tweak.
model/server/registry.yaml UNIX casing + “client-side” wording.
model/rpc/registry.yaml “server-side/client-side” hyphenation.
model/README.md “Markdown/Visual Studio Code” naming fixes.
model/process/metrics.yaml UNIX casing tweak in brief.
model/pprof/registry.yaml Expand “regexp” to “regular expression”.
model/otel/registry.yaml “built-in” hyphenation fixes.
model/otel/metrics.yaml HTTP/gRPC casing in note.
model/os/registry.yaml UNIX casing in brief text.
model/os/entities.yaml “macOS” casing fix in table.
model/oracledb/registry.yaml SQL casing in note.
model/network/registry.yaml Wi‑Fi casing + UNIX casing + enum brief.
model/network/deprecated/registry-deprecated.yaml UNIX casing in brief text.
model/messaging/spans.yaml “partition ID” casing fixes.
model/messaging/registry.yaml “ID” casing fixes in attribute briefs.
model/messaging/deprecated/registry-deprecated.yaml “partition ID” casing in deprecated note.
model/messaging/common.yaml UNIX casing in note.
model/mcp/deprecated/spans-deprecated.yaml “client-side” hyphenation.
model/mcp/deprecated/registry-deprecated.yaml “URI” casing in brief.
model/log/registry.yaml “ID” casing in note.
model/kestrel/metrics.yaml “YAML” casing in TODO comment.
model/k8s/metrics.yaml CPU casing fixes in metric briefs.
model/k8s/deprecated/registry-deprecated.yaml K8s casing in brief text.
model/host/registry.yaml UNIX casing in brief text.
model/host/entities.yaml “machine ID” casing + “macOS” casing.
model/geo/registry.yaml “end user” wording tweak.
model/gen-ai/deprecated/spans-deprecated.yaml “conversation ID” casing fixes.
model/gen-ai/deprecated/events-deprecated.yaml “ID” casing fixes in docs text.
model/gcp/common.yml Fix YAML indentation/structure.
model/file/registry.yaml “filename/internet” wording tweaks.
model/feature-flags/events.yaml “YAML” casing in TODO comment.
model/faas/spans.yaml “server-side” hyphenation.
model/enduser/deprecated/registry-deprecated.yaml “end user” wording tweak.
model/dotnet/network-spans.yaml hostname/hostnames wording tweaks.
model/destination/registry.yaml UNIX casing in brief text.
model/deployment/registry.yaml “ID” casing fix.
model/db/spans.yaml username/URL/JSON casing and wording tweaks.
model/cpu/registry.yaml CPU casing in brief text.
model/container/registry.yaml Docker/ID wording tweaks.
model/container/metrics.yaml Clarify CPU time brief; CPU casing.
model/code/registry.yaml “filename” wording tweak.
model/cloudfoundry/registry.yaml “vm ID” casing tweak.
model/client/registry.yaml UNIX casing + “server-side” hyphenation.
model/aspnetcore/registry.yaml “username” wording tweak.
model/artifact/registry.yaml filename/ID wording tweaks.
model/android/registry.yaml Android casing fix.
internal/tools/scripts/update-areas-table.py “bug fixes” wording tweak.
docs/system/system-metrics.md Regenerated doc text (UNIX, Linux casing).
docs/system/process-metrics.md Regenerated doc text (UNIX casing).
docs/system/k8s-metrics.md Regenerated doc text (CPU casing).
docs/system/container-metrics.md Regenerated doc text (CPU brief/casing).
docs/rpc/rpc-spans.md Regenerated doc text (UNIX, client-side).
docs/rpc/rpc-metrics.md Regenerated doc text (server-side/client-side).
docs/rpc/json-rpc.md Regenerated doc text (UNIX, client-side).
docs/rpc/grpc.md Regenerated doc text (UNIX, client-side).
docs/rpc/dubbo.md Regenerated doc text (UNIX, client-side).
docs/rpc/connect-rpc.md Regenerated doc text (UNIX, client-side).
docs/resource/zos.md Regenerated doc text (UNIX casing).
docs/resource/README.md Editorial fixes (K8s wording, Git hash).
docs/resource/process.md Editorial fixes (frontend; runtime examples).
docs/resource/os.md Regenerated doc text (macOS/UNIX casing).
docs/resource/k8s/README.md Editorial fix (“UID” casing).
docs/resource/host.md Regenerated doc text (UNIX/machine ID/macOS).
docs/resource/container.md Regenerated doc text (Docker casing).
docs/resource/cloudfoundry.md Regenerated doc text (“IDs”, “vm ID”).
docs/resource/android.md Regenerated doc text (Android casing).
docs/registry/entities/telemetry.md Regenerated doc text (language descriptions).
docs/registry/entities/os.md Regenerated doc text (macOS/UNIX casing).
docs/registry/entities/host.md Regenerated doc text (UNIX/machine ID/macOS).
docs/registry/entities/container.md Regenerated doc text (Docker/Repo wording).
docs/registry/entities/cloudfoundry.md Regenerated doc text (“vm ID” casing).
docs/registry/entities/android.md Regenerated doc text (Android casing).
docs/registry/attributes/url.md Regenerated doc text (URL/filename casing).
docs/registry/attributes/tls.md Regenerated doc text (SSL/TLS descriptions).
docs/registry/attributes/telemetry.md Regenerated doc text (language descriptions).
docs/registry/attributes/source.md Regenerated doc text (UNIX casing).
docs/registry/attributes/session.md Regenerated doc text (“ID” casing).
docs/registry/attributes/server.md Regenerated doc text (UNIX, client-side).
docs/registry/attributes/rpc.md Regenerated doc text (server-side/client-side).
docs/registry/attributes/pprof.md Regenerated doc text (“regular expression”).
docs/registry/attributes/otel.md Regenerated doc text (“built-in”).
docs/registry/attributes/os.md Regenerated doc text (UNIX casing).
docs/registry/attributes/oracledb.md Regenerated doc text (SQL casing).
docs/registry/attributes/network.md Regenerated doc text (Wi‑Fi/UNIX casing).
docs/registry/attributes/messaging.md Regenerated doc text (“ID” casing).
docs/registry/attributes/mcp.md Regenerated doc text (URI casing).
docs/registry/attributes/log.md Regenerated doc text (“ID” casing).
docs/registry/attributes/k8s.md Regenerated doc text (K8s casing).
docs/registry/attributes/host.md Regenerated doc text (UNIX casing).
docs/registry/attributes/geo.md Regenerated doc text (“end user”).
docs/registry/attributes/file.md Regenerated doc text (filename/internet).
docs/registry/attributes/enduser.md Regenerated doc text (“end user”).
docs/registry/attributes/destination.md Regenerated doc text (UNIX casing).
docs/registry/attributes/deployment.md Regenerated doc text (“ID” casing).
docs/registry/attributes/cpu.md Regenerated doc text (CPU casing).
docs/registry/attributes/container.md Regenerated doc text (Docker/Repo wording).
docs/registry/attributes/code.md Regenerated doc text (“filename”).
docs/registry/attributes/cloudfoundry.md Regenerated doc text (“vm ID” casing).
docs/registry/attributes/client.md Regenerated doc text (UNIX, server-side).
docs/registry/attributes/aspnetcore.md Regenerated doc text (“username”).
docs/registry/attributes/artifact.md Regenerated doc text (filename/ID).
docs/registry/attributes/android.md Regenerated doc text (Android casing).
docs/non-normative/groups/system/cpu-metrics-guidelines.md K8s casing in guidance text.
docs/non-normative/code-generation.md Editorial wording/casing tweaks.
docs/nfs/nfs-metrics.md Regenerated doc text (UNIX casing).
docs/messaging/sqs.md Regenerated doc text (UNIX, client-side).
docs/messaging/sns.md Regenerated doc text (UNIX, client-side).
docs/messaging/rocketmq.md Regenerated doc text (UNIX, “message ID”).
docs/messaging/rabbitmq.md Regenerated doc text (UNIX, client-side).
docs/messaging/messaging-spans.md Editorial tweaks (key-value; prefetched).
docs/messaging/kafka.md Regenerated doc text (UNIX, “partition ID”).
docs/messaging/gcp-pubsub.md Regenerated doc text (UNIX, “ack ID”).
docs/messaging/azure-messaging.md Regenerated doc text (UNIX, “partition ID”).
docs/how-to-write-conventions/resource-and-entities.md Editorial tweaks (K8s/Kubernetes wording).
docs/how-to-write-conventions/README.md Editorial tweaks (“end user”).
docs/general/session.md Regenerated doc text (“ID” casing).
docs/general/profiles.md Regenerated doc text (“regular expression”).
docs/general/naming.md Editorial tweak (HTTP casing).
docs/general/logs.md Regenerated doc text (“ID” casing).
docs/faas/faas-spans.md Regenerated doc text (“server-side”).
docs/exceptions/exceptions-spans.md Editorial casing fixes (JavaScript/SDK).
docs/dotnet/dotnet-network-traces.md Regenerated doc text (UNIX, SSL/TLS, hostname).
docs/dotnet/dotnet-http-metrics.md HTTP casing + client-side wording.
docs/dotnet/dotnet-aspnetcore-metrics.md Regenerated doc text (“username”).
docs/db/sql.md client-side wording tweak.
docs/db/sql-server.md client-side wording tweak.
docs/db/redis.md UNIX casing + client-side wording.
docs/db/postgresql.md username + client-side wording.
docs/db/oracledb.md SQL casing + client-side wording.
docs/db/mysql.md client-side wording tweak.
docs/db/mongodb.md client-side wording tweak.
docs/db/mariadb.md client-side wording tweak.
docs/db/hbase.md client-side wording tweak.
docs/db/elasticsearch.md URL/JSON casing + client-side wording.
docs/db/database-spans.md client-side wording + “Backends”.
docs/db/database-metrics.md client-side wording tweaks.
docs/db/couchdb.md client-side wording tweak.
docs/db/cosmosdb.md client-side wording tweaks.
docs/db/cassandra.md client-side wording tweaks.
docs/cicd/cicd-metrics.md CPU casing in bullet list.
CONTRIBUTING.md Editorial fixes (“repository”, “Markdown”, etc.).
AREAS.md “bug fixes” wording tweak in notes.

Comment thread docs/messaging/messaging-spans.md Outdated
Comment thread docs/resource/README.md Outdated
Comment thread docs/how-to-write-conventions/resource-and-entities.md Outdated
Comment thread docs/resource/process.md Outdated
Comment thread docs/resource/process.md Outdated
Comment thread docs/resource/process.md Outdated
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
@thompson-tomo

Copy link
Copy Markdown
Contributor Author

@lmolkova all of the copilot suggestions have been addressed & conflicts resolved.

@github-actions github-actions Bot removed the Stale label Jun 23, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Development

Successfully merging this pull request may close these issues.

2 participants