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

Documentation for usage without events dataset out of date #73

Open
firste opened this issue Aug 8, 2024 · 0 comments
Open

Documentation for usage without events dataset out of date #73

firste opened this issue Aug 8, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@firste
Copy link
Collaborator

firste commented Aug 8, 2024

Problem Summary

With the UX improvements in 0.2.0 release, configuration expectations for events became more strict and the events section in usage config is required. We previously had documentation about how to configure seismometer without an event file in the FAQ that needs to be amended.

Suggested fix

Readd the following to the FAQ RST
'''
events:
- source: Target Column Name
display_name: Target Column Display Name
usage: target
'''

@firste firste added documentation Improvements or additions to documentation good first issue Good for newcomers labels Aug 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant