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

Added new use cases and description of the use case - 5/14/24 #16451

Merged
merged 5 commits into from
Jun 4, 2024

Conversation

amit-git-account
Copy link
Contributor

The use case listing is not changed in a long time. While speaking with users, I came across several other use cases not listed here in the index. So I added new use cases and also added description against the use cases.

Fixes #XXXX.

Description

Fixed the bug ...

Renamed the class ...

Added a forbidden-apis entry ...

Release note


Key changed/added classes in this PR
  • MyFoo
  • OurBar
  • TheirBaz

This PR has:

  • [ x] been self-reviewed.
  • [x ] added documentation for new or modified features or behaviors.
  • a release note entry in the PR description.
  • added Javadocs for most classes and all non-trivial methods. Linked related entities via Javadoc links.
  • added or updated version, license, or notice information in licenses.yaml
  • added comments explaining the "why" and the intent of the code wherever would not be obvious for an unfamiliar reader.
  • added unit tests or modified existing tests to cover new code paths, ensuring the threshold for code coverage is met.
  • added integration tests.
  • been tested in a test Druid cluster.

The use case listing is not changed in a long time. While speaking with users, I came across several other use cases not listed here in the index. So I added new use cases and also added description against the use cases.
Copy link
Contributor

@techdocsmith techdocsmith left a comment

Choose a reason for hiding this comment

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

other than minor suggestions, LGTM

docs/design/index.md Outdated Show resolved Hide resolved
docs/design/index.md Outdated Show resolved Hide resolved
docs/design/index.md Outdated Show resolved Hide resolved
Copy link
Contributor Author

@amit-git-account amit-git-account left a comment

Choose a reason for hiding this comment

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

Thanks Charles

|Digital marketing/advertising analytics|Tracking and analyzing the effectiveness of digital marketing campaigns and advertising efforts across various channels, such as social media, search engines, and display ads|
|Business intelligence (BI)/OLAP (Online Analytical Processing)|Utilizing data analysis tools and techniques to gather insights from large datasets, generate reports, and make data-driven decisions to improve business operations and strategy|
|Customer analytics|Analyzing customer data to understand preferences, behavior, and purchasing patterns, enabling personalized marketing strategies, improved customer service, and customer retention efforts|
|IoT (Internet of Things) analytics|Processing and analyzing data generated by IoT devices to gain insights into device performance, user behavior, and environmental conditions, facilitating automation, optimization, and predictive maintenance|
Copy link
Contributor

Choose a reason for hiding this comment

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

need to add IoT to ./.spelling

|IoT (Internet of Things) analytics|Processing and analyzing data generated by IoT devices to gain insights into device performance, user behavior, and environmental conditions, facilitating automation, optimization, and predictive maintenance|
|Financial analytics|Leveraging data analysis techniques to evaluate financial performance, manage risk, detect fraud, and make informed investment decisions|
|Healthcare analytics|Analyzing healthcare data to improve patient outcomes, optimize healthcare delivery, reduce costs, and identify trends and patterns in diseases and treatments|
|Social media analytics|Monitoring and analyzing social media activity, such as likes, shares, comments, and mentions, to understand audience sentiment, track brand perception, and identify influencers|
Copy link
Contributor

Choose a reason for hiding this comment

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

need to add influencers to ./.spelling

@techdocsmith
Copy link
Contributor

@amit-git-account : I added 2 comments -- to resolve the spelling issues, you need to edit .spelling in the docs website directory & add IoT and influencers

docs/design/index.md Outdated Show resolved Hide resolved
docs/design/index.md Outdated Show resolved Hide resolved
docs/design/index.md Outdated Show resolved Hide resolved
docs/design/index.md Outdated Show resolved Hide resolved
docs/design/index.md Outdated Show resolved Hide resolved
docs/design/index.md Outdated Show resolved Hide resolved
docs/design/index.md Outdated Show resolved Hide resolved
docs/design/index.md Outdated Show resolved Hide resolved
docs/design/index.md Outdated Show resolved Hide resolved
docs/design/index.md Outdated Show resolved Hide resolved
docs/design/index.md Outdated Show resolved Hide resolved
docs/design/index.md Outdated Show resolved Hide resolved
Copy link
Contributor

@ektravel ektravel left a comment

Choose a reason for hiding this comment

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

For improved readability, I recommend avoiding the gerunds.

techdocsmith and others added 3 commits May 31, 2024 16:57
Co-authored-by: Katya Macedo  <38017980+ektravel@users.noreply.github.com>
Co-authored-by: Katya Macedo  <38017980+ektravel@users.noreply.github.com>
docs/design/index.md Outdated Show resolved Hide resolved
@techdocsmith techdocsmith merged commit 540d3e6 into apache:master Jun 4, 2024
12 checks passed
317brian pushed a commit to 317brian/druid that referenced this pull request Jun 4, 2024
…#16451)

Thanks for your contribution @amit-git-account

* Added new use cases and description of the use case - 5/14/24

The use case listing is not changed in a long time. While speaking with users, I came across several other use cases not listed here in the index. So I added new use cases and also added description against the use cases.

* Apply suggestions from code review

Co-authored-by: Katya Macedo  <38017980+ektravel@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Katya Macedo  <38017980+ektravel@users.noreply.github.com>

* update spelling file

* Update docs/design/index.md

---------

Co-authored-by: Charles Smith <techdocsmith@gmail.com>
Co-authored-by: Katya Macedo <38017980+ektravel@users.noreply.github.com>
Co-authored-by: 317brian <53799971+317brian@users.noreply.github.com>
Co-authored-by: Benedict Jin <asdf2014@apache.org>
(cherry picked from commit 540d3e6)
techdocsmith added a commit that referenced this pull request Jun 4, 2024
* docs: Migration guide for subquery limit (#16519)

Adds a migration guide for Druid 30 to help users understand the new byte-based subquery limit property maxSubqueryBytes

(cherry picked from commit 3c72ec8)

* Adds a migration guide overview page to the release-info section (#16506)

Co-authored-by: 317brian <53799971+317brian@users.noreply.github.com>
Co-authored-by: Katya Macedo <katya.macedo@imply.io>
(cherry picked from commit 92e565e)

* Update front coding text (#16491)

Co-authored-by: 317brian <53799971+317brian@users.noreply.github.com>
Co-authored-by: Victoria Lim <vtlim@users.noreply.github.com>
(cherry picked from commit f70ef1f)

* docs: Adds a redirect for flatten-json which was removed (#16263)

(cherry picked from commit b1568fb)

* docs: add lookups to the sidebar (#16530)

Co-authored-by: 317brian <53799971+317brian@users.noreply.github.com>
(cherry picked from commit 8f78c90)

* Added new use cases and description of the use case - 5/14/24 (#16451)

Thanks for your contribution @amit-git-account

* Added new use cases and description of the use case - 5/14/24

The use case listing is not changed in a long time. While speaking with users, I came across several other use cases not listed here in the index. So I added new use cases and also added description against the use cases.

* Apply suggestions from code review

Co-authored-by: Katya Macedo  <38017980+ektravel@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Katya Macedo  <38017980+ektravel@users.noreply.github.com>

* update spelling file

* Update docs/design/index.md

---------

Co-authored-by: Charles Smith <techdocsmith@gmail.com>
Co-authored-by: Katya Macedo <38017980+ektravel@users.noreply.github.com>
Co-authored-by: 317brian <53799971+317brian@users.noreply.github.com>
Co-authored-by: Benedict Jin <asdf2014@apache.org>
(cherry picked from commit 540d3e6)

* docs: add subquery limit migration guide to overview page

* fix typo

* update migration guide blurb for subquerybytes

* caps

---------

Co-authored-by: Jill Osborne <jill.osborne@imply.io>
Co-authored-by: Charles Smith <techdocsmith@gmail.com>
Co-authored-by: Katya Macedo <38017980+ektravel@users.noreply.github.com>
Co-authored-by: Amit <31014730+amit-git-account@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants