Skip to content

[docs] update contributing guide for current tooling and OTel mappings#2593

Open
kgeller wants to merge 1 commit intoelastic:mainfrom
kgeller:contributing-docs-updates
Open

[docs] update contributing guide for current tooling and OTel mappings#2593
kgeller wants to merge 1 commit intoelastic:mainfrom
kgeller:contributing-docs-updates

Conversation

@kgeller
Copy link
Copy Markdown
Contributor

@kgeller kgeller commented Mar 26, 2026

Summary

Updates CONTRIBUTING.md and supporting docs to reflect the current state of the repo. Most advanced developer docs were already up-to-date in USAGE.md and scripts/docs/; these changes fix the gaps.

  • Dev Tools: add Python dependency install step
  • Documentation section: replace stale asciidoc references with Markdown; fix generated-files table (correct paths, templates, and generator); simplify Jinja subsection with pointer to scripts/docs/markdown-generator.md
  • Schema Files: add OTel Mappings subsection documenting the otel: block and relation types, linked to scripts/docs/otel-integration.md
  • Additional Resources: add links to USAGE.md and scripts/docs/
  • Table of contents: expand to cover new subsections
  • schemas/README.md: document the otel field key
  • docs/reference/ecs-contributing.md: fix mastermain link

@kgeller kgeller self-assigned this Mar 26, 2026
@kgeller kgeller added the DOCS Any issue related to ECS documentation label Mar 26, 2026
@github-actions
Copy link
Copy Markdown

🤖 GitHub comments

Expand to view the GitHub comments

Just comment with:

  • run docs-build : Re-trigger the docs validation. (use unformatted text in the comment!)

@github-actions
Copy link
Copy Markdown

Documentation changes preview: https://docs-v3-preview.elastic.dev/elastic/ecs/pull/2593/reference/

@kgeller kgeller marked this pull request as ready for review March 26, 2026 21:18
@kgeller kgeller requested a review from a team March 26, 2026 21:18
```YAML
otel:
- relation: equivalent
attribute: url.full
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

The equivalent example uses attribute: url.full, but url.full in schemas/url.yml is mapped with relation: match — not equivalent. Using a field that is actually match to illustrate equivalent will mislead contributors. Please substitute a field that genuinely has relation: equivalent (e.g. service.environmentdeployment.environment.name, or error.messageexception.message) so the example is accurate.

Copy link
Copy Markdown

@qcorporation qcorporation left a comment

Choose a reason for hiding this comment

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

Besides the example nitpick: it looks good

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

DOCS Any issue related to ECS documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants