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.

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

[OAS][DOCS] Add temporary overlays for Kibana API documents #189322

Merged
merged 10 commits into from
Aug 1, 2024

Conversation

lcawl
Copy link
Contributor

@lcawl lcawl commented Jul 26, 2024

Summary

This PR adds some overlays to work-around the following issues:

The makefile is also updated to (1) omit the SLO APIs from the stateful Kibana APIs, (2) make the make api-docs-lint command also lint the output from the make api-docs-overlay command.

@lcawl lcawl added Team:Docs docs backport:prev-minor Backport to (8.x) the previous minor version (i.e. one version back from main) Feature:OAS Work or issues related to Core-provided mechanisms for generating OAS labels Jul 26, 2024
@obltmachine
Copy link

🤖 GitHub comments

Expand to view the GitHub comments

Just comment with:

  • /oblt-deploy : Deploy a Kibana instance using the Observability test environments.
  • run docs-build : Re-trigger the docs validation. (use unformatted text in the comment!)

@lcawl lcawl marked this pull request as ready for review July 26, 2024 21:37
@lcawl lcawl requested a review from a team as a code owner July 26, 2024 21:37
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-docs (Team:Docs)

@lcawl lcawl added the release_note:skip Skip the PR/issue when compiling release notes label Jul 26, 2024
@lcawl lcawl requested review from jloleysens and removed request for jloleysens July 26, 2024 22:14
Copy link
Contributor

@karenzone karenzone left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Contributor

@jloleysens jloleysens left a comment

Choose a reason for hiding this comment

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

Great work @lcawl

@kibana-ci
Copy link
Collaborator

💚 Build Succeeded

Metrics [docs]

✅ unchanged

History

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

@lcawl lcawl merged commit 176a221 into elastic:main Aug 1, 2024
19 checks passed
@lcawl lcawl deleted the api-overlays branch August 1, 2024 16:38
@kibanamachine
Copy link
Contributor

💔 All backports failed

Status Branch Result
8.15 Backport failed because of merge conflicts

You might need to backport the following PRs to 8.15:
- [DOCS][OAS] Add alerting to Kibana API bundle (#188885)
- [DOCS][OAS] Add cases to Kibana API bundle (#189020)

Manual backport

To create the backport manually run:

node scripts/backport --pr 189322

Questions ?

Please refer to the Backport tool documentation

lcawl added a commit to lcawl/kibana that referenced this pull request Aug 1, 2024
@lcawl
Copy link
Contributor Author

lcawl commented Aug 1, 2024

💚 All backports created successfully

Status Branch Result
8.15

Note: Successful backport PRs will be merged automatically after passing CI.

Questions ?

Please refer to the Backport tool documentation

lcawl added a commit that referenced this pull request Aug 2, 2024
…189322) (#189734)

# Backport

This will backport the following commits from `main` to `8.15`:
- [[OAS][DOCS] Add temporary overlays for Kibana API documents
(#189322)](#189322)

<!--- Backport version: 8.9.8 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT [{"author":{"name":"Lisa
Cawley","email":"[email protected]"},"sourceCommit":{"committedDate":"2024-08-01T16:38:01Z","message":"[OAS][DOCS]
Add temporary overlays for Kibana API documents
(#189322)","sha":"176a2210d769ff004cb0669e002f69099febbec3","branchLabelMapping":{"^v8.16.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Team:Docs","release_note:skip","docs","backport:prev-minor","Feature:OAS","v8.16.0"],"number":189322,"url":"https://github.com/elastic/kibana/pull/189322","mergeCommit":{"message":"[OAS][DOCS]
Add temporary overlays for Kibana API documents
(#189322)","sha":"176a2210d769ff004cb0669e002f69099febbec3"}},"sourceBranch":"main","suggestedTargetBranches":[],"targetPullRequestStates":[{"branch":"main","label":"v8.16.0","labelRegex":"^v8.16.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/189322","number":189322,"mergeCommit":{"message":"[OAS][DOCS]
Add temporary overlays for Kibana API documents
(#189322)","sha":"176a2210d769ff004cb0669e002f69099febbec3"}}]}]
BACKPORT-->
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport:prev-minor Backport to (8.x) the previous minor version (i.e. one version back from main) docs Feature:OAS Work or issues related to Core-provided mechanisms for generating OAS release_note:skip Skip the PR/issue when compiling release notes Team:Docs v8.15.0 v8.16.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants