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] Link to new API site #119038

Open
wants to merge 9 commits into
base: main
Choose a base branch
from
Open

[DOCS] Link to new API site #119038

wants to merge 9 commits into from

Conversation

lcawl
Copy link
Contributor

@lcawl lcawl commented Dec 19, 2024

This PR updates the first batch of API pages to link to the new API docs (https://www.elastic.co/docs/api/doc/elasticsearch)

@lcawl lcawl added >docs General docs changes auto-backport Automatically create backport pull requests when merged documentation v8.17.1 v8.18.0 labels Dec 19, 2024
@lcawl lcawl requested a review from a team December 19, 2024 03:35
Copy link
Contributor

Documentation preview:

@lcawl lcawl marked this pull request as ready for review December 19, 2024 17:30
@elasticsearchmachine elasticsearchmachine added the Team:Docs Meta label for docs team label Dec 19, 2024
@elasticsearchmachine
Copy link
Collaborator

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

Copy link
Contributor

@shainaraskas shainaraskas left a comment

Choose a reason for hiding this comment

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

YAY!!
reviewed with some style nits!

@@ -4,6 +4,13 @@

NOTE: {cloud-only}


.New API Reference
Copy link
Contributor

Choose a reason for hiding this comment

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

IMO reference should be uncapitalized

Suggested change
.New API Reference
.New API reference

.New API Reference
[sidebar]
--
For the most up-to-date API details, refer to {api-es}/group/endpoint-autoscaling[autoscaling APIs].
Copy link
Contributor

Choose a reason for hiding this comment

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

and I believe we would want to capitalize these section titles (just the first word)

Suggested change
For the most up-to-date API details, refer to {api-es}/group/endpoint-autoscaling[autoscaling APIs].
For the most up-to-date API details, refer to {api-es}/group/endpoint-autoscaling[Autoscaling APIs].

.New API Reference
[sidebar]
--
For the most up-to-date API details, refer to {api-es}/group/endpoint-cat[CAT APIs].
Copy link
Contributor

Choose a reason for hiding this comment

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

nit:

Suggested change
For the most up-to-date API details, refer to {api-es}/group/endpoint-cat[CAT APIs].
For the most up-to-date API details, refer to {api-es}/group/endpoint-cat[Compact and aligned text (CAT) APIs].

.New API Reference
[sidebar]
--
For the most up-to-date API details, refer to {api-es}/group/endpoint-ccr[CCR APIs].
Copy link
Contributor

Choose a reason for hiding this comment

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

nit

Suggested change
For the most up-to-date API details, refer to {api-es}/group/endpoint-ccr[CCR APIs].
For the most up-to-date API details, refer to {api-es}/group/endpoint-ccr[Cross-cluster replication APIs].

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
auto-backport Automatically create backport pull requests when merged >docs General docs changes documentation Team:Docs Meta label for docs team v8.17.1 v8.18.0 v9.0.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants