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

[api-docs] follow the correct schema for frontmatter #138348

Merged
merged 4 commits into from
Aug 10, 2022
Merged

[api-docs] follow the correct schema for frontmatter #138348

merged 4 commits into from
Aug 10, 2022

Conversation

spalger
Copy link
Contributor

@spalger spalger commented Aug 9, 2022 •
edited
Loading

This updates the api-docs generation tools a little to do three things:

  • remove the invalid warning field and use a comment at the top of the front-matter instead
  • rename the summary field to description, summary is not a supported field and does nothing (syntax docs)
  • place the warning in a standard location so that it's consistent across the generated files

@spalger spalger added Team:Operations Team label for Operations Team release_note:skip Skip the PR/issue when compiling release notes labels Aug 9, 2022
@spalger spalger marked this pull request as ready for review August 9, 2022 02:16
@spalger spalger requested a review from a team as a code owner August 9, 2022 02:16
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-operations (Team:Operations)

@spalger spalger requested a review from a team August 9, 2022 02:22
@spalger spalger requested review from a team as code owners August 9, 2022 02:22
@kibana-ci
Copy link
Collaborator

💚 Build Succeeded

Metrics [docs]

✅ unchanged

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

cjcenizal
cjcenizal approved these changes Aug 9, 2022
View reviewed changes
Copy link
Contributor

@cjcenizal cjcenizal left a comment

Choose a reason for hiding this comment

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

Changes to form lib docs LGTM.

afharo
afharo approved these changes Aug 10, 2022
View reviewed changes
Copy link
Member

@afharo afharo left a comment

Choose a reason for hiding this comment

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

LGTM

@spalger spalger merged commit 6c438b3 into elastic:main Aug 10, 2022
@spalger spalger deleted the fix/api-docs-frontmatter-schema branch August 10, 2022 22:17
@kibanamachine kibanamachine added v8.5.0 backport:skip This commit does not require backporting labels Aug 10, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@cjcenizal cjcenizal cjcenizal approved these changes

@jbudz jbudz jbudz approved these changes

@afharo afharo afharo approved these changes

@Dosant Dosant Dosant approved these changes

Assignees
No one assigned
Labels
backport:skip This commit does not require backporting release_note:skip Skip the PR/issue when compiling release notes Team:Operations Team label for Operations Team v8.5.0
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
8 participants
@spalger @elasticmachine @kibana-ci @cjcenizal @jbudz @afharo @Dosant @kibanamachine