-
Notifications
You must be signed in to change notification settings - Fork 20
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
Updates Get started page #183
Conversation
A documentation preview will be available soon. Request a new doc build by commenting
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. |
run docs-build |
We might want to consider a more substantive revision given that the automated index creation process is now front and centre. We can chat about this next week. :) |
* fixing exists API link * fixing images on index management page
* Adds Trained model autoscaling page * Update serverless/pages/ml-nlp-auto-scale.mdx Co-authored-by: István Zoltán Szabó <[email protected]> * Update serverless/pages/ml-nlp-auto-scale.mdx Co-authored-by: István Zoltán Szabó <[email protected]> * Update serverless/pages/ml-nlp-auto-scale.mdx Co-authored-by: István Zoltán Szabó <[email protected]> * Update serverless/pages/ml-nlp-auto-scale.mdx Co-authored-by: István Zoltán Szabó <[email protected]> * Update serverless/pages/ml-nlp-auto-scale.mdx Co-authored-by: István Zoltán Szabó <[email protected]> * Update serverless/pages/ml-nlp-auto-scale.mdx Co-authored-by: István Zoltán Szabó <[email protected]> * Update serverless/pages/ml-nlp-auto-scale.mdx Co-authored-by: István Zoltán Szabó <[email protected]> * Update serverless/pages/ml-nlp-auto-scale.mdx Co-authored-by: István Zoltán Szabó <[email protected]> * Update serverless/pages/ml-nlp-auto-scale.mdx Co-authored-by: István Zoltán Szabó <[email protected]> * Update serverless/pages/ml-nlp-auto-scale.mdx Co-authored-by: István Zoltán Szabó <[email protected]> * Update serverless/pages/ml-nlp-auto-scale.mdx Co-authored-by: István Zoltán Szabó <[email protected]> * Update serverless/pages/ml-nlp-auto-scale.mdx Co-authored-by: István Zoltán Szabó <[email protected]> * Changes paragraph placement * Update serverless/pages/ml-nlp-auto-scale.mdx Co-authored-by: István Zoltán Szabó <[email protected]> * Update serverless/pages/ml-nlp-auto-scale.mdx Co-authored-by: Dima Arnautov <[email protected]> * Updates document based on feedback * mdx to asciidoc * Updates table --------- Co-authored-by: István Zoltán Szabó <[email protected]> Co-authored-by: Dima Arnautov <[email protected]> Co-authored-by: Colleen McGinnis <[email protected]>
run docs-build |
run docs-build |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just quick note about examples.
Co-authored-by: Liam Thompson <[email protected]>
Co-authored-by: Liam Thompson <[email protected]>
@kosabogi Here's what I'm thinking would be the most helpful for users, with 3 branches in terms of getting started. We should make these 3 options clear on this page:
Concretely, that means we should delegate the ingest and search stuff to the UI. So we can remove the ingest and search instructions. The Continue on your own section should be:
The On this page might look something like this after these changes. |
I like the idea of breaking out the API key creation into a standalone page. I also think that in the existing get started guide the Perhaps we could also have these on that new page, and maybe give the page a more general title like 'Connecting to your Elasticsearch Serverless endpoint' |
run docs-build |
Thanks for the feedback @leemthompo ! I updated the structure and provided some quick start guides as well. Please let me know if you have any suggestions or additions related to those. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looking good, few suggestions here to tighten up the connection details page.
I think the get-started page still needs a bit of love:
I think we should make the 3 getting started options explicit:
- Option 1: Follow the guided index flow
- Option 2: Follow the in-product getting started tutorial
- Option 3: Explore on your own, where you'll need:
- Your connection details
- Choose an ingestion option (just link to ingest page)
- Once you've got data in, try Playground
Co-authored-by: Liam Thompson <[email protected]>
Co-authored-by: Liam Thompson <[email protected]>
Co-authored-by: Liam Thompson <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looking good, I have a few minor suggestions. This should be close to the finish line, thanks for iterating!
Co-authored-by: Liam Thompson <[email protected]>
Co-authored-by: Liam Thompson <[email protected]>
Co-authored-by: Liam Thompson <[email protected]>
Co-authored-by: Liam Thompson <[email protected]>
Co-authored-by: Liam Thompson <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looking great! Final few tweaks, I'll approve once those are made because otherwise will have to re-review anyway :)
Co-authored-by: Liam Thompson <[email protected]>
Co-authored-by: Liam Thompson <[email protected]>
Co-authored-by: Liam Thompson <[email protected]>
Co-authored-by: Liam Thompson <[email protected]>
Co-authored-by: Liam Thompson <[email protected]>
Co-authored-by: Liam Thompson <[email protected]>
Co-authored-by: Liam Thompson <[email protected]>
Co-authored-by: Liam Thompson <[email protected]>
Co-authored-by: Liam Thompson <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for iterating! This is a nice improvement for new users looking to get started. 🚢
Overview
This PR modifies the Get started guide to match the current flow. After creating a serverless project, users now land on the Home page instead of the Getting Started page.
Related issue
#154
Preview