Skip to content

Add field maturity and remove experimental pipeline#2599

Merged
kgeller merged 5 commits intoelastic:mainfrom
kgeller:alpha-beta-maturity
Apr 7, 2026
Merged

Add field maturity and remove experimental pipeline#2599
kgeller merged 5 commits intoelastic:mainfrom
kgeller:alpha-beta-maturity

Conversation

@kgeller
Copy link
Copy Markdown
Member

@kgeller kgeller commented Apr 3, 2026

Summary

  • Add alpha as a first-class schema attribute mirroring beta (validation, reuse propagation, doc rendering), with mutual exclusion enforced
  • Remove the experimental/ build pipeline, directory, and unused cgroup.* fields — zero adoption, container.* already covers the use case
  • Document field stability definitions (alpha, beta, GA) and promotion criteria in ecs-principles-design.md
  • Update authoring docs in schemas/README.md, USAGE.md, and internal developer docs

This is the first of three PRs: (1) alpha maturity + remove experimental, (2) streamline RFC process, (3) annotate in-flight RFCs.

Test plan

  • make test — 153 tests pass
  • make generate — clean build, no diff
  • No stale experimental references in .py, .yml, .j2, or Makefile
  • Beta fieldset (device) renders correctly — no regression
  • Manually added alpha to agent.version, confirmed italic marker renders in generated docs, then reverted

@kgeller kgeller self-assigned this Apr 3, 2026
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Apr 3, 2026

🤖 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
Contributor

github-actions Bot commented Apr 3, 2026

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

Comment thread docs/reference/ecs-principles-design.md Outdated
Comment thread schemas/README.md
Copy link
Copy Markdown
Contributor

@trisch-me trisch-me left a comment

Choose a reason for hiding this comment

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

lgtm

Co-authored-by: Alexandra Konrad <alexandra.konrad@elastic.co>
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Apr 7, 2026

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Apr 7, 2026

Vale Linting Results

Summary: 1 suggestion found

💡 Suggestions (1)
File Line Rule Message
docs/reference/ecs-principles-design.md 60 Elastic.WordChoice Consider using 'can, might' instead of 'may', unless the term is in the UI.

The Vale linter checks documentation changes against the Elastic Docs style guide.

To use Vale locally or report issues, refer to Elastic style guide for Vale.

@trisch-me
Copy link
Copy Markdown
Contributor

one thing that came to my mind - in our docs we don’t have a prominent beta (or alpha) sign, we only have This field is beta and subject to change.

Maybe we should add a tag similar to what we do for otel such as related? and put it near the name so that person see at once the maturity status. Or even use a new column for maturity. wdyt?

@kgeller
Copy link
Copy Markdown
Member Author

kgeller commented Apr 7, 2026

one thing that came to my mind - in our docs we don’t have a prominent beta (or alpha) sign, we only have This field is beta and subject to change.

Maybe we should add a tag similar to what we do for otel such as related? and put it near the name so that person see at once the maturity status. Or even use a new column for maturity. wdyt?

@trisch-me we can consult with the docs team on this as a followup? It definitely sounds nice to make it clearer, but I think it would be great to get their take on it to make sure we can match existing / define the convention

@trisch-me
Copy link
Copy Markdown
Contributor

sure, do you know who is contact person for this? :)

@kgeller
Copy link
Copy Markdown
Member Author

kgeller commented Apr 7, 2026

sure, do you know who is contact person for this? :)

I'm not sure, my plan was to post in their slack channel 😄

@kgeller kgeller merged commit 21faddb into elastic:main Apr 7, 2026
7 checks passed
@kgeller kgeller deleted the alpha-beta-maturity branch April 7, 2026 19:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants