Skip to content

Conversation

leemthompo
Copy link
Contributor

@leemthompo leemthompo commented Nov 5, 2024

Aggregations tutorial using Kibana sample e-commerce data

TODO:

  • Add links: lots added in a049416
  • Include complete responses
  • Investigate test setup
    • We're not going to have time to instrument snippet tests for this in this PR
    • Fortunately, the data and queries are not bleeding edge, so they should be stable
    • If we have bandwidth we can revisit adding tests in follow-up

👁️‍🗨️ URL preview

@leemthompo leemthompo added >docs General docs changes Team:Docs Meta label for docs team auto-backport Automatically create backport pull requests when merged v8.15.0 v8.16.0 v9.0.0 v8.17.0 labels Nov 5, 2024
@leemthompo leemthompo self-assigned this Nov 5, 2024
Copy link
Contributor

github-actions bot commented Nov 5, 2024

Documentation preview:

Copy link
Member

@kderusso kderusso left a comment

Choose a reason for hiding this comment

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

Nice start!

}
}
----
// TEST[skip:Using Kibana sample data]
Copy link
Member

Choose a reason for hiding this comment

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

It might be better to prepopulate some of this, and just stub in the example values we want in the test. That way CI will break if these ever change and no longer work.

Copy link
Contributor

Choose a reason for hiding this comment

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

++

Copy link
Contributor

@Mikep86 Mikep86 left a comment

Choose a reason for hiding this comment

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

Great first draft, I like the journey you lead the user on, it has good flow :)

}
}
----
// TEST[skip:Using Kibana sample data]
Copy link
Contributor

Choose a reason for hiding this comment

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

++


Refer to the <<search-aggregations,aggregations reference>> for more details on all available aggregation types.

//TODO add relevant links judiciously No newline at end of file
Copy link
Contributor

Choose a reason for hiding this comment

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

Good to see we agree about the need for lots of links to supporting content. Of course, I see this after leaving lots of comments about where links are needed 🫠

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sorry I should have been clearer about that in the PR description, my bad 🙏

* Standardize on "eCommerce" capitalization throughout
* Add cross-references to relevant documentation
* Improve technical explanations and callouts
* Clarify requirements section organization
* Add more context around distributed search behavior
* Fix bullet point consistency
* Add missing section introductions
* Enhance date format and interval explanations
@leemthompo
Copy link
Contributor Author

Thanks @Mikep86 and @kderusso, apart from the TODOs, is there anything additional you'd like to see in this tutorial?

@georgewallace
Copy link
Contributor

Is there any reason to add scripts in aggregations or metadata? I only ask as we do talk about those in the serverless aggregation content. Or is that outside of basics for aggregations?

@kderusso
Copy link
Member

@leemthompo Sorry for the delay in response, catching back up after PTO. I think the content here is good, we just need to flesh out some of the example responses and tests 👍

@leemthompo leemthompo changed the title [DOCS] Aggregations quickstart tutorial [DOCS][101] Aggregations quickstart tutorial Dec 10, 2024
@leemthompo
Copy link
Contributor Author

@kderusso @Mikep86 this one had to sit on the sidelines for a while, will have to punt on snippet testing for moment due to bandwidth, but this shouldn't block publishing. I'll do another polish pass tomorrow to make sure all the annotations make sense, otherwise hopefully this should be ready to go.

@leemthompo leemthompo marked this pull request as ready for review December 11, 2024 10:31
@elasticsearchmachine
Copy link
Collaborator

Pinging @elastic/es-docs (Team:Docs)

Copy link
Member

@kderusso kderusso left a comment

Choose a reason for hiding this comment

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

Approving to unblock because this is a good guide, but it would be nice to get tests working in a followup.

@leemthompo leemthompo merged commit 56e1ca5 into elastic:main Dec 11, 2024
5 checks passed
@elasticsearchmachine
Copy link
Collaborator

💔 Backport failed

Status Branch Result
8.15 Commit could not be cherrypicked due to conflicts
8.16 Commit could not be cherrypicked due to conflicts
8.17 Commit could not be cherrypicked due to conflicts
8.x Commit could not be cherrypicked due to conflicts

You can use sqren/backport to manually backport by running backport --upstream elastic/elasticsearch --pr 116251

leemthompo added a commit to leemthompo/elasticsearch that referenced this pull request Dec 11, 2024
(cherry picked from commit 56e1ca5)

# Conflicts:
#	docs/reference/quickstart/index.asciidoc
leemthompo added a commit to leemthompo/elasticsearch that referenced this pull request Dec 11, 2024
(cherry picked from commit 56e1ca5)

# Conflicts:
#	docs/reference/quickstart/index.asciidoc
leemthompo added a commit to leemthompo/elasticsearch that referenced this pull request Dec 11, 2024
(cherry picked from commit 56e1ca5)

# Conflicts:
#	docs/reference/quickstart/index.asciidoc
@leemthompo
Copy link
Contributor Author

💚 All backports created successfully

Status Branch Result
8.x
8.17
8.16
8.15

Questions ?

Please refer to the Backport tool documentation

leemthompo added a commit to leemthompo/elasticsearch that referenced this pull request Dec 11, 2024
(cherry picked from commit 56e1ca5)

# Conflicts:
#	docs/reference/quickstart/index.asciidoc
@leemthompo leemthompo deleted the aggs-qs branch December 11, 2024 15:25
elasticsearchmachine pushed a commit that referenced this pull request Dec 11, 2024
(cherry picked from commit 56e1ca5)

# Conflicts:
#	docs/reference/quickstart/index.asciidoc
elasticsearchmachine pushed a commit that referenced this pull request Dec 11, 2024
(cherry picked from commit 56e1ca5)

# Conflicts:
#	docs/reference/quickstart/index.asciidoc
elasticsearchmachine pushed a commit that referenced this pull request Dec 11, 2024
(cherry picked from commit 56e1ca5)

# Conflicts:
#	docs/reference/quickstart/index.asciidoc
elasticsearchmachine pushed a commit that referenced this pull request Dec 11, 2024
(cherry picked from commit 56e1ca5)

# Conflicts:
#	docs/reference/quickstart/index.asciidoc
sarog pushed a commit to portsbuild/elasticsearch that referenced this pull request Jan 22, 2025
…c#118469)

(cherry picked from commit 56e1ca5)

# Conflicts:
#	docs/reference/quickstart/index.asciidoc
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

auto-backport Automatically create backport pull requests when merged backport pending >docs General docs changes Team:Docs Meta label for docs team v8.15.0 v8.16.0 v8.17.0 v8.18.0 v9.0.0

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants