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

docs(insights): Example event name should change with eventType #3619

Merged
merged 2 commits into from
Aug 30, 2024

Conversation

JonathanMontane
Copy link
Contributor

@JonathanMontane JonathanMontane commented Aug 30, 2024

🧭 What and Why

Looking at the spec for View Filters and seeing example name: Product Clicked is confusing.

image

🎟 JIRA Ticket: None

Changes included:

  • Added examples to the eventName attribute of each concretization of the event concept
  • Removed based example on eventName attribute (to keep the spec json schema compliant)

🧪 Test

?? <- Let me know how I can do that! I ran yarn website to generate the bundled version and it seemed okay, but 🤷‍♂️ and I don't know how to view the website locally 😅

@JonathanMontane JonathanMontane requested a review from a team as a code owner August 30, 2024 09:57
@algolia-bot
Copy link
Collaborator

algolia-bot commented Aug 30, 2024

✔️ Code generated!

Name Link
🪓 Triggered by 98090191cb3ee9519fdb9851980d5d0c8632c1de
🍃 Generated commit e273dde11c622e2bd6b81655f15caf5016e2b88e
🌲 Generated branch generated/fix/insights/confusing-shared-example
📊 Benchmark results

Benchmarks performed on the method using a mock server, the results might not reflect the real-world performance.

Language Req/s
javascript 1592
php 1461
csharp 1098
python 963
java 956
ruby 949
swift 754
go 552
kotlin 486

Copy link

@millotp
Copy link
Collaborator

millotp commented Aug 30, 2024

the website this repo is only for internal doc and how to contribute, the real doc is on https://github.com/algolia/doc and will be updated on the next release of the api clients, its a little bit hard currently to see the changes, but it's something we should improve !

Copy link
Collaborator

@millotp millotp left a comment

Choose a reason for hiding this comment

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

looks good !

@millotp millotp merged commit 45f96ed into main Aug 30, 2024
25 checks passed
@millotp millotp deleted the fix/insights/confusing-shared-example branch August 30, 2024 10:49
algolia-bot added a commit that referenced this pull request Aug 30, 2024
… (generated) [skip ci]

Co-authored-by: Jonathan Montane <JonathanMontane@users.noreply.github.com>
Co-authored-by: Pierre Millot <pierre.millot@algolia.com>
millotp added a commit that referenced this pull request Aug 30, 2024
Co-authored-by: Pierre Millot <pierre.millot@algolia.com>
millotp added a commit that referenced this pull request Aug 30, 2024
… (generated) [skip ci]

Co-authored-by: Jonathan Montane <JonathanMontane@users.noreply.github.com>
Co-authored-by: Pierre Millot <pierre.millot@algolia.com>
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