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

[Only merge when 8.16 becomes current][8.x] Direct users to new API reference site (backport #5911) #5914

Open
wants to merge 1 commit into
base: 8.x
Choose a base branch
from

Conversation

mergify[bot]
Copy link

@mergify mergify bot commented Oct 11, 2024

Contributes to https:/elastic/security-docs-internal/issues/48.

Add callouts to the asciidoc API docs to direct users to the new API reference site, in preparation for retiring the asciidoc API docs.

NOTE: The api-kibana variable is defined in version-specific files. In 8.15.asciidoc and 8.x.asciidoc, the variable points to the v8 branch of the API reference, which currently doesn't include Security API docs. The v8 branch is derived from the "current" Kibana branch, which is currently 8.15. This likely means that we can only backport the callouts to 8.16 once 8.16 becomes the "current" docs version.


This is an automatic backport of pull request #5911 done by Mergify.

@mergify mergify bot requested a review from a team as a code owner October 11, 2024 09:16
@mergify mergify bot added the backport label Oct 11, 2024
Copy link

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.

@natasha-moore-elastic
Copy link
Contributor

Per the note in the description, we should only merge this backport once 8.16 becomes current. Otherwise, as shown in this preview, we'd be directing users to a version of Kibana APIs that doesn't include Security APIs.

@natasha-moore-elastic natasha-moore-elastic changed the title [8.x] Direct users to new API reference site (backport #5911) [Only merge when 8.16 becomes current][8.x] Direct users to new API reference site (backport #5911) Oct 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant