Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Only generate documentation link in component template _meta for actual ecs fields #1728

Merged
merged 4 commits into from
Jan 12, 2022
Merged

Only generate documentation link in component template _meta for actual ecs fields #1728

merged 4 commits into from
Jan 12, 2022

Conversation

kgeller
Copy link
Contributor

@kgeller kgeller commented Jan 12, 2022

Fixes #1501

Previously:
The component template _meta generated when custom fields are passed provides an invalid URL:

"_meta": {
    "documentation": "https://www.elastic.co/guide/en/ecs/current/ecs-acme.html", 
    "ecs_version": "1.10.0"
  }

Now:
We only attach _meta.documentation for ECS fields
acme:

"_meta": {
    "ecs_version": "8.2.0-dev"
  }

organization:

"_meta": {
    "documentation": "https://www.elastic.co/guide/en/ecs/current/ecs-organization.html",
    "ecs_version": "8.2.0-dev"
  }

@kgeller kgeller added the 8.1.0 label Jan 12, 2022
@kgeller kgeller requested a review from a team January 12, 2022 15:53
@kgeller kgeller self-assigned this Jan 12, 2022
ebeahan
ebeahan approved these changes Jan 12, 2022
View reviewed changes
Copy link
Member

@ebeahan ebeahan left a comment

Choose a reason for hiding this comment

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

LGTM 👍

@kgeller kgeller merged commit ed80a06 into elastic:main Jan 12, 2022
@kgeller kgeller deleted the fix-invalid-url-generated branch January 12, 2022 17:33
@ebeahan ebeahan mentioned this pull request Mar 7, 2022
Merged
@ebeahan
Copy link
Member

ebeahan commented Mar 7, 2022

💚 All backports created successfully

Status Branch Result
✅ 8.1

Questions ?

Please refer to the Backport tool documentation

ebeahan pushed a commit to ebeahan/ecs that referenced this pull request Mar 7, 2022
@kgeller @ebeahan
Only generate documentation link in component template _meta for actu…
afac67b 
…al ecs fields (elastic#1728)

(cherry picked from commit ed80a06)
ebeahan added a commit that referenced this pull request Mar 7, 2022
@ebeahan @kgeller
Only generate documentation link in component template _meta for actu…
5bb0c1c 
…al ecs fields (#1728) (#1827)

(cherry picked from commit ed80a06)

Co-authored-by: Kylie Geller <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ebeahan ebeahan ebeahan approved these changes

Assignees

@kgeller kgeller

Labels
8.1.0
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Invalid URL generated in component template _meta for custom fields
2 participants
@kgeller @ebeahan