docs: Docs refinement and quickstart added by eedugon · Pull Request #624 · elastic/cli · GitHub
Skip to content

docs: Docs refinement and quickstart added - #624

Merged
JoshMock merged 7 commits into
elastic:mainfrom
eedugon:cli_docs_initial_refinement
Sep 11, 2026
Merged

JoshMock merged 7 commits into
elastic:mainfrom
eedugon:cli_docs_initial_refinement

Conversation

@eedugon

@eedugon eedugon commented Sep 10, 2026

Copy link
Copy Markdown
Contributor

Summary

Improves the Elastic CLI documentation and onboarding journey by:

  • Refreshing the landing, installation, configuration, and command reference content (minor changes, with some extra explanations in some areas).
  • Adding an end-to-end Elasticsearch quickstart.
  • Adding a tutorial for connecting to Elastic Cloud and listing Hosted deployments and Serverless projects.
  • Clarifying contexts, credentials, API key types, and configuration options.
  • Standardizing product substitutions and cross-repository links.

Validation

  • Vale passes.
  • All changed pages were checked in the local docs preview.

Closes https://github.com/elastic/docs-content-internal/issues/1154

Co-authored-by: Cursor <cursoragent@cursor.com>
@eedugon
eedugon force-pushed the cli_docs_initial_refinement branch from 1d80393 to 36ecf5d Compare September 10, 2026 20:28
@eedugon

eedugon commented Sep 10, 2026

Copy link
Copy Markdown
Contributor Author

eedugon and others added 2 commits September 10, 2026 22:47
@eedugon
eedugon marked this pull request as ready for review September 11, 2026 07:48

@georgewallace georgewallace left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This all honestly looks fantastic.. Everything ran perfectly, only one comment where you have a couple lines that read different but are very similar.

Comment thread docs/cli/manage-elastic-cloud.md
The quickstart and the Elastic Cloud guide describe the same read -rs
step with different wording and an extra intro sentence that ends in a
colon without a code block after it. Follow the Cloud guide pattern in
both places.

Co-authored-by: Cursor <cursoragent@cursor.com>
@JoshMock JoshMock changed the title Docs refinement and quickstart added docs: Docs refinement and quickstart added Sep 11, 2026
@github-actions

Copy link
Copy Markdown
Contributor

🔍 Preview links for changed docs

⏳ Building and deploying preview... View progress

This comment will be updated with preview links when the build is complete.

@github-actions

Copy link
Copy Markdown
Contributor

@JoshMock JoshMock 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.

This is fantastic. Thank you for all these improvements! No notes, happy to merge when you are.

eedugon added a commit to elastic/docs-content that referenced this pull request Sep 11, 2026
## Summary

Adds identity mappings for the five static section anchors defined in
`search-connection-details.md`. The page has a self-redirect for legacy
anchor aliases; without these mappings, cross-repository deep links to
its current anchors fail validation.

For example, [elastic/cli#624](elastic/cli#624)
links to the explicitly defined `find-endpoint-cloud-self-managed`
anchor:

```
docs-content://solutions/elasticsearch-solution-project/search-connection-details.md#find-endpoint-cloud-self-managed
```

Although that anchor exists in the current document, validation fails
because the self-redirect intercepts the link and its anchor map only
handles legacy aliases:

```
Redirect rule for 'solutions/elasticsearch-solution-project/search-connection-details.md' in 'docs-content' found, but top-level rule did not handle anchor '#find-endpoint-cloud-self-managed'.
```

This provides at least a temporary solution that keeps the current
document linkable through its explicitly defined section anchors while
preserving the legacy anchor redirects. The H1 anchor and generated
anchors are intentionally excluded.

## Generative AI disclosure

1. Did you use a generative AI (GenAI) tool to assist in creating this
contribution?
- [x] Yes
- [ ] No

Tool(s) and model(s) used: Cursor with GPT-5.6 Sol. Used to inspect the
redirect behavior, verify every added anchor against the static anchors
in the source document, and prepare this focused change.

Co-authored-by: Cursor <cursoragent@cursor.com>
@JoshMock
JoshMock merged commit 3106c05 into elastic:main Sep 11, 2026
34 checks passed
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