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

Best practices for Heartbeat tool #97

Open
texasRanger09 opened this issue Jun 13, 2024 · 1 comment
Open

Best practices for Heartbeat tool #97

texasRanger09 opened this issue Jun 13, 2024 · 1 comment

Comments

@texasRanger09
Copy link
Contributor

Add best practices to the README for the heartbeat tool. Cover topics such as:

  1. Adding a subscription (When/why you would add this)
  2. What kind of data to add to metaData field
  3. Frequency for secondsInterval
@okdistribute
Copy link
Collaborator

okdistribute commented Jul 10, 2024

Instead of the readme this content is likely best in the documentation Best Practices section. We can then link to that from this readme.

See other dev tools for an example here where more comprehensive docs are linked to, rather than trying to fit it all into a readme.

Cc @bplattenburg related to this quarter's goals

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

No branches or pull requests

2 participants