Skip to content
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

Merged
merged 36 commits into from
Nov 19, 2024
Merged

Conversation

kosabogi
Copy link
Contributor

@kosabogi kosabogi commented Nov 8, 2024

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

@kosabogi kosabogi requested a review from leemthompo November 8, 2024 12:56
@kosabogi kosabogi requested a review from a team as a code owner November 8, 2024 12:56
Copy link

github-actions bot commented Nov 8, 2024

A documentation preview will be available soon.

Request a new doc build by commenting
  • Rebuild this PR: run docs-build
  • Rebuild this PR and all Elastic docs: run docs-build rebuild

run docs-build is much faster than run docs-build rebuild. A rebuild should only be needed in rare situations.

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.

@kosabogi
Copy link
Contributor Author

kosabogi commented Nov 8, 2024

run docs-build

@leemthompo
Copy link
Contributor

leemthompo commented Nov 8, 2024

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. :)

georgewallace and others added 3 commits November 12, 2024 13:53
* 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]>
@kosabogi
Copy link
Contributor Author

run docs-build

@kosabogi kosabogi marked this pull request as draft November 12, 2024 12:58
@kosabogi kosabogi marked this pull request as ready for review November 12, 2024 13:12
@kosabogi
Copy link
Contributor Author

run docs-build

@leemthompo leemthompo marked this pull request as draft November 12, 2024 14:05
@leemthompo leemthompo marked this pull request as ready for review November 12, 2024 14:06
Copy link
Contributor

@leemthompo leemthompo left a 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.

serverless/pages/get-started.asciidoc Outdated Show resolved Hide resolved
serverless/pages/get-started.asciidoc Outdated Show resolved Hide resolved
serverless/pages/get-started.asciidoc Outdated Show resolved Hide resolved
@leemthompo
Copy link
Contributor

leemthompo commented Nov 13, 2024

@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:

  1. Follow the new guided index creation flow
  2. Follow the in-product Getting started
  3. Add data using another method and explore on your own

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:

  • Renamed to better fit number 3.
  • Outline all the potential ingest options, basically this image in text.
    • Alternatively we could just link to the Ingest page
      • Then in a follow up make that whole Ingest section simply a single page that reflects all ingest options.
  • Provide nice links to quickstarts, notebooks etc. We should definitely highlight Playground as a great place to go once you've got some data in.

The On this page might look something like this after these changes.

@leemthompo
Copy link
Contributor

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
Copy URL and Test connection steps are helpful for users.

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'

@kosabogi
Copy link
Contributor Author

run docs-build

@kosabogi
Copy link
Contributor Author

@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:

  1. Follow the new guided index creation flow
  2. Follow the in-product Getting started
  3. Add data using another method and explore on your own

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:

  • Renamed to better fit number 3.

  • Outline all the potential ingest options, basically this image in text.

    • Alternatively we could just link to the Ingest page

      • Then in a follow up make that whole Ingest section simply a single page that reflects all ingest options.
  • Provide nice links to quickstarts, notebooks etc. We should definitely highlight Playground as a great place to go once you've got some data in.

The On this page might look something like this after these changes.

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.

Copy link
Contributor

@leemthompo leemthompo left a 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

serverless/pages/connecting-to-es-endpoint.asciidoc Outdated Show resolved Hide resolved
serverless/pages/connecting-to-es-endpoint.asciidoc Outdated Show resolved Hide resolved
serverless/pages/connecting-to-es-endpoint.asciidoc Outdated Show resolved Hide resolved
serverless/pages/connecting-to-es-endpoint.asciidoc Outdated Show resolved Hide resolved
serverless/pages/connecting-to-es-endpoint.asciidoc Outdated Show resolved Hide resolved
serverless/pages/connecting-to-es-endpoint.asciidoc Outdated Show resolved Hide resolved
Copy link
Contributor

@leemthompo leemthompo left a 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!

serverless/pages/get-started.asciidoc Outdated Show resolved Hide resolved
serverless/pages/get-started.asciidoc Outdated Show resolved Hide resolved
serverless/pages/get-started.asciidoc Show resolved Hide resolved
serverless/pages/get-started.asciidoc Show resolved Hide resolved
serverless/pages/get-started.asciidoc Outdated Show resolved Hide resolved
serverless/pages/get-started.asciidoc Outdated Show resolved Hide resolved
serverless/pages/get-started.asciidoc Outdated Show resolved Hide resolved
serverless/pages/get-started.asciidoc Show resolved Hide resolved
Copy link
Contributor

@leemthompo leemthompo left a 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 :)

serverless/pages/get-started.asciidoc Outdated Show resolved Hide resolved
serverless/pages/get-started.asciidoc Outdated Show resolved Hide resolved
serverless/pages/get-started.asciidoc Outdated Show resolved Hide resolved
serverless/pages/get-started.asciidoc Outdated Show resolved Hide resolved
serverless/pages/get-started.asciidoc Outdated Show resolved Hide resolved
serverless/pages/get-started.asciidoc Outdated Show resolved Hide resolved
serverless/pages/get-started.asciidoc Outdated Show resolved Hide resolved
Copy link
Contributor

@leemthompo leemthompo left a 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. 🚢

@kosabogi kosabogi merged commit 46c134e into elastic:main Nov 19, 2024
3 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