[DOCS] Collapse some content in local dev setup for readability #112355
Conversation
leemthompo
added
>docs
|
Documentation preview: |
|
Pinging @elastic/es-docs (Team:Docs) |
| [%collapsible] | ||
| ============== | ||
| You'll use the following connection details: |
There was a problem hiding this comment.
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
There was a problem hiding this comment.
ah 💯 I'll reword the text because I actually want to clear as much real estate as possible on this page :)
There was a problem hiding this comment.
@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.
There was a problem hiding this comment.
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
|
|
||
| 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 details |
There was a problem hiding this comment.
I dunno if I love this bolding - feels like all of it or none of it should be bolded
There was a problem hiding this comment.
I need a style guide refresh on some of this stuff, merging for now :)
…tic#112355) * [DOCS] Collapse some content in local dev setup for readability * Reword collapsible text
…tic#112355) * [DOCS] Collapse some content in local dev setup for readability * Reword collapsible text (cherry picked from commit 3d2ca69)
…tic#112355) * [DOCS] Collapse some content in local dev setup for readability * Reword collapsible text (cherry picked from commit 3d2ca69)
💚 All backports created successfully
Note: Successful backport PRs will be merged automatically after passing CI. Questions ?Please refer to the Backport tool documentation |
ℹ️ Learn more about AsciiDoc collapsibles.