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

Improve Elasticsearch serverless APIs docs landing page #207

Merged
merged 5 commits into from
Nov 21, 2024

Conversation

leemthompo
Copy link
Contributor

@leemthompo leemthompo commented Nov 20, 2024

Attempts to:

  • Add clear section headings
  • Group related content logically
  • Add descriptive summaries for each API set
  • Improve navigation with direct links

ℹ️ I didn't touch this page but I think it probably needs updating too, should title be "{serverless-full} API conventions' rather than "Management API conventions"?

Before / after

Before

after1

After

after

@leemthompo leemthompo requested a review from lcawl November 20, 2024 11:56
@leemthompo leemthompo self-assigned this Nov 20, 2024
@leemthompo leemthompo requested a review from a team as a code owner November 20, 2024 11:56
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.

lcawl
lcawl previously approved these changes Nov 21, 2024
Copy link
Contributor

@lcawl lcawl left a comment

Choose a reason for hiding this comment

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

LGTM!

@leemthompo leemthompo merged commit 1680745 into elastic:main Nov 21, 2024
2 checks passed
@leemthompo leemthompo deleted the refactor-api-page branch November 21, 2024 09:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants