docs: integrate Elastic CLI into existing API guides by eedugon · Pull Request #8277 · elastic/docs-content · GitHub
Skip to content

docs: integrate Elastic CLI into existing API guides - #8277

Open
eedugon wants to merge 3 commits into
elastic:mainfrom
eedugon:docs/add-elastic-cli-links
Open

eedugon wants to merge 3 commits into
elastic:mainfrom
eedugon:docs/add-elastic-cli-links

Conversation

@eedugon

@eedugon eedugon commented Sep 11, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Integrates the Elastic CLI into existing documentation through contextual links and short descriptions where useful.
  • Adds CLI references to Cloud and self-managed tool catalogs and to Cloud API workflow pages.
  • Registers the cli repository for cli:// cross-repository links.

Dependencies

This PR must not be merged until both of these PRs are merged:

Related to elastic/docs-content-internal#1154.

Validation

  • Vale reports no new issues on the changed lines.
  • git diff --check passes.
  • docs-builder resolves all added cli://index.md links.

Generative AI disclosure

  1. Did you use a generative AI (GenAI) tool to assist in creating this contribution?
  • Yes
  • No
  1. Tool(s) and model(s) used: Cursor with GPT-5.6 Sol.

Made with Cursor

AI-Assisted: Cursor
Co-authored-by: Cursor <cursoragent@cursor.com>
@github-actions

Copy link
Copy Markdown
Contributor

@github-actions

Copy link
Copy Markdown
Contributor

✅ Elastic Docs Style Checker (Vale)

No issues found on modified lines!


The Vale linter checks documentation changes against the Elastic Docs style guide. To use Vale locally or report issues, refer to Elastic style guide for Vale.

@shainaraskas shainaraskas left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

lgtm. I smell lots of possibilities!

I think, to round this out, you would want to call out the CLI in these spots too:

(similar to how we talk about cluster-level stuff in these pages)

and https://docs-v3-preview.elastic.dev/elastic/docs-content/pull/8277/reference to surface the new CLI reference wherever we have it sat

Comment on lines +36 to +39
:::{tip}
:applies_to: serverless: preview
For a command-line workflow, use the [Elastic CLI](cli://index.md) to run supported project operations. For an example of how to connect the CLI to {{ecloud}} and manage projects, follow [Connect to {{ecloud}} with the Elastic CLI](cli://cli/manage-elastic-cloud.md).
:::

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I'd prob move this one up above the resources heading, because these are all links to api reference material specifically, but this is closer to an alternative pathway to doing these operations. similar to the agent skill callout

:::{include} /deploy-manage/deploy/_snippets/other-apis.md
:::

## Manage Elastic APIs with the Elastic CLI

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I think "manage apis" is the wrong phrasing here because it's just another interaction layer - you're using the apis via the cli, not managing them. I'd prob simplify down to just a product title, similar to the console entry and the ecctl entry

Suggested change
## Manage Elastic APIs with the Elastic CLI
## Elastic CLI

alt that is not better

Suggested change
## Manage Elastic APIs with the Elastic CLI
## Elastic Cloud through Elastic CLI

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

is "reuses" the right word here? makes it seem a little insecure

do we want to say all of the operations here, or can we just say "all of the operations"?

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.

2 participants