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

[DOCS] Remove saved object and data view API pages #190654

Merged
merged 8 commits into from
Aug 20, 2024
Merged

Conversation

@lcawl lcawl added Feature:Saved Objects release_note:skip Skip the PR/issue when compiling release notes docs backport:prev-minor Backport to (8.x) the previous minor version (i.e. one version back from main) labels Aug 16, 2024
Copy link
Contributor

A documentation preview will be available soon.

Request a new doc build by commenting
  • Rebuild this PR: run docs-build
  • Rebuild this PR and all Elastic docs: run docs-build rebuild

run docs-build is much faster than run docs-build rebuild. A rebuild should only be needed in rare situations.

If your PR continues to fail for an unknown reason, the doc build pipeline may be broken. Elastic employees can check the pipeline status here.

@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 requested a review from a team August 19, 2024 14:53
@lcawl lcawl marked this pull request as ready for review August 19, 2024 14:53
@lcawl lcawl marked this pull request as draft August 19, 2024 16:24
@lcawl lcawl changed the title [DOCS] Remove saved object API pages [DOCS] Remove saved object and data view API pages Aug 19, 2024
@lcawl lcawl marked this pull request as ready for review August 19, 2024 20:34
@kibana-ci
Copy link
Collaborator

💚 Build Succeeded

History

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

Copy link
Contributor

@florent-leborgne florent-leborgne left a comment

Choose a reason for hiding this comment

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

LGTM, with very minor alignment on how these deprecation notes refer to the saved objects API(s?)

docs/api/dashboard/export-dashboard.asciidoc Outdated Show resolved Hide resolved
docs/api/dashboard-api.asciidoc Outdated Show resolved Hide resolved
docs/api/saved-objects.asciidoc Outdated Show resolved Hide resolved
lcawl and others added 4 commits August 20, 2024 08:43
Co-authored-by: florent-leborgne <florent.leborgne@elastic.co>
Co-authored-by: florent-leborgne <florent.leborgne@elastic.co>
Co-authored-by: florent-leborgne <florent.leborgne@elastic.co>
@lcawl lcawl enabled auto-merge (squash) August 20, 2024 17:09
@lcawl lcawl merged commit cf43ba2 into elastic:main Aug 20, 2024
7 checks passed
kibanamachine pushed a commit to kibanamachine/kibana that referenced this pull request Aug 20, 2024
Co-authored-by: florent-leborgne <florent.leborgne@elastic.co>
(cherry picked from commit cf43ba2)
@kibanamachine
Copy link
Contributor

💚 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

kibanamachine added a commit that referenced this pull request Aug 20, 2024
…190842)

# Backport

This will backport the following commits from `main` to `8.15`:
- [[DOCS] Remove saved object and data view API pages
(#190654)](#190654)

<!--- Backport version: 9.4.3 -->

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

<!--BACKPORT [{"author":{"name":"Lisa
Cawley","email":"lcawley@elastic.co"},"sourceCommit":{"committedDate":"2024-08-20T17:29:06Z","message":"[DOCS]
Remove saved object and data view API pages (#190654)\n\nCo-authored-by:
florent-leborgne
<florent.leborgne@elastic.co>","sha":"cf43ba2f2702bdcb857d19290931ba6bfc84ff5a","branchLabelMapping":{"^v8.16.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Feature:Saved
Objects","release_note:skip","docs","backport:prev-minor","v8.16.0"],"title":"[DOCS]
Remove saved object and data view API
pages","number":190654,"url":"https://github.com/elastic/kibana/pull/190654","mergeCommit":{"message":"[DOCS]
Remove saved object and data view API pages (#190654)\n\nCo-authored-by:
florent-leborgne
<florent.leborgne@elastic.co>","sha":"cf43ba2f2702bdcb857d19290931ba6bfc84ff5a"}},"sourceBranch":"main","suggestedTargetBranches":[],"targetPullRequestStates":[{"branch":"main","label":"v8.16.0","branchLabelMappingKey":"^v8.16.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/190654","number":190654,"mergeCommit":{"message":"[DOCS]
Remove saved object and data view API pages (#190654)\n\nCo-authored-by:
florent-leborgne
<florent.leborgne@elastic.co>","sha":"cf43ba2f2702bdcb857d19290931ba6bfc84ff5a"}}]}]
BACKPORT-->

Co-authored-by: Lisa Cawley <lcawley@elastic.co>
@TinaHeiligers
Copy link
Contributor

TinaHeiligers commented Aug 20, 2024

@lcawl I wish I'd seen this PR before merge.
Core needs to retain the 'deprecated' status of some of these APIs in the main landing page for saved objects APIs. We don't need details, I'd prefer keeping the original page and changing the links instead. Something similar to the import dashboards API would be perfect!

With the changes in this PR, users might think we've decided against removing most of them (they've been experimental for years) and do nothing, only to get frustrated when the APIs are removed in 9.0.

TinaHeiligers added a commit that referenced this pull request Aug 29, 2024
Fix #191534
The deprecation warning in the Kibana Saved Objects API main page was
removed in #190654.

This PR adds a section about when the APIs will be removed and what to
use instead.

The PR also includes updates to other API main pages that mention the SO
APIs.

- [x]
[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)
was added for features that require explanation or tutorials

VIew the [html
diff](https://kibana_bk_191693.docs-preview.app.elstc.co/diff) for these
changes:

![Short URLs API landing
page](https://github.com/user-attachments/assets/3716f33e-0d00-4ff7-b29d-7a5ba0a0f1f2)

![Data views API landing
page](https://github.com/user-attachments/assets/81c8a843-27ca-4510-a181-7ec9b20f86d6)

The updated OpenAPI document looks like this in a Bump.sh preview:


![image](https://github.com/user-attachments/assets/a8b58142-5082-4b75-8b3f-339b8a6b57e4)

---------

Co-authored-by: lcawl <lcawley@elastic.co>
iblancof pushed a commit to iblancof/kibana that referenced this pull request Aug 30, 2024
Fix elastic#191534
The deprecation warning in the Kibana Saved Objects API main page was
removed in elastic#190654.

This PR adds a section about when the APIs will be removed and what to
use instead.

The PR also includes updates to other API main pages that mention the SO
APIs.

- [x]
[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)
was added for features that require explanation or tutorials

VIew the [html
diff](https://kibana_bk_191693.docs-preview.app.elstc.co/diff) for these
changes:

![Short URLs API landing
page](https://github.com/user-attachments/assets/3716f33e-0d00-4ff7-b29d-7a5ba0a0f1f2)

![Data views API landing
page](https://github.com/user-attachments/assets/81c8a843-27ca-4510-a181-7ec9b20f86d6)

The updated OpenAPI document looks like this in a Bump.sh preview:


![image](https://github.com/user-attachments/assets/a8b58142-5082-4b75-8b3f-339b8a6b57e4)

---------

Co-authored-by: lcawl <lcawley@elastic.co>
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:Saved Objects release_note:skip Skip the PR/issue when compiling release notes v8.15.1 v8.16.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants