Skip to content

[DOCS] Collapse some content in local dev setup for readability #112355

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Sep 2, 2024
Merged

[DOCS] Collapse some content in local dev setup for readability #112355

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d36e702
[DOCS] Collapse some content in local dev setup for readability
leemthompo Aug 29, 2024
852b4d1
Reword collapsible text
leemthompo Aug 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions docs/reference/quickstart/run-elasticsearch-locally.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,10 @@ The service is started with a trial license. The trial license enables all featu

To connect to the {es} cluster from a language client, you can use basic authentication with the `elastic` username and the password you set in the environment variable.

.*Expand* for examples
[%collapsible]
==============

You'll use the following connection details:
Copy link
Contributor

Choose a reason for hiding this comment

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

the collapsible title indicates to me that you're just hiding examples, but it looks like you're also hiding the default endpoint and auth details here

Copy link
Contributor Author

Choose a reason for hiding this comment

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

ah 💯 I'll reword the text because I actually want to clear as much real estate as possible on this page :)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@shainaraskas do you think we could get away with pulling out this text from intro too?

Feels like excessive text is clogging up reader's working memory. Want this to really be about copying and running the ~5 commands.

When would I use this setup?

Use this setup if you want to quickly spin up Elasticsearch (and Kibana) for local development or testing.

For example you might:

Want to run a quick test to see how a feature works.
Follow a tutorial or guide that requires an Elasticsearch cluster, like our quick start guide.
Experiment with the Elasticsearch APIs using different tools, like the Dev Tools Console, cURL, or an Elastic programming language client.
Quickly spin up an Elasticsearch cluster to test an executable Python notebook locally.

Copy link
Contributor

Choose a reason for hiding this comment

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

I like it. people don't have to read it if they don't care - we have scannable headings on the page they can use to jump to the part they are interested in.

personally, I don't agree with hiding content behind a collapsible element, but since it pops open when we search it's ok


* **{es} endpoint**: `http://localhost:9200`
Expand Down Expand Up @@ -160,6 +164,8 @@ curl -u elastic:$ELASTIC_PASSWORD \
----
// NOTCONSOLE

==============

[discrete]
[[local-dev-next-steps]]
=== Next steps
Expand Down
Loading