Direct users to new API reference site #5911
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
natasha-moore-elastic
added
API
Priority: Medium
|
A documentation preview will be available soon. Request a new doc build by commenting
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. |
nastasha-solomon
approved these changes
Oct 10, 2024
Contributor
nastasha-solomon
left a comment
nastasha-solomon
left a comment
There was a problem hiding this comment.
Spot-checked a few pages and skimmed the changed files tab. Everything looks great! Thanks for adding these banners, @natasha-moore-elastic!
mergify bot
pushed a commit
that referenced
this pull request
Oct 11, 2024
(cherry picked from commit 2d2a22b)
Contributor
Author
|
@Mergifyio backport 8.16.0 |
Contributor
❌ No backport have been created
GitHub error: |
Contributor
Author
|
https://github.com/Mergifyio backport 8.16 |
Contributor
✅ Backports have been created
|
mergify bot
pushed a commit
that referenced
this pull request
Nov 13, 2024
(cherry picked from commit 2d2a22b) # Conflicts: # docs/advanced-entity-analytics/api/asset-criticality-api-overview.asciidoc
natasha-moore-elastic
added a commit
that referenced
this pull request
Nov 13, 2024
* Direct users to new API reference site (#5911) (cherry picked from commit 2d2a22b) # Conflicts: # docs/advanced-entity-analytics/api/asset-criticality-api-overview.asciidoc * resolves conflict --------- Co-authored-by: natasha-moore-elastic <[email protected]> Co-authored-by: natasha-moore-elastic <[email protected]>
natasha-moore-elastic
added a commit
that referenced
this pull request
Nov 13, 2024
(cherry picked from commit 2d2a22b) Co-authored-by: natasha-moore-elastic <[email protected]>
acorretti
pushed a commit
that referenced
this pull request
Nov 19, 2024
(cherry picked from commit bf56e06) # Conflicts: # docs/advanced-entity-analytics/api/asset-criticality-api-overview.asciidoc
acorretti
pushed a commit
that referenced
this pull request
Nov 19, 2024
(cherry picked from commit bf56e06)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Contributes to https://github.com/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-kibanavariable 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.