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: metrics collection markdown file #9

Merged

Conversation

peter-rr
Copy link
Collaborator

@peter-rr peter-rr commented Jan 18, 2024

Description
Adding METRICS_COLLECTION.md file to share all the details about AsyncAPI metrics usage.

@peter-rr peter-rr changed the title docs: Metrics collection markdown file docs: metrics collection markdown file Jan 18, 2024
@peter-rr
Copy link
Collaborator Author

peter-rr commented Jan 18, 2024

Note

The document is still in progress. Not ready for review yet.

@peter-rr
Copy link
Collaborator Author

@smoya
Document already finished. Ready for review 👍

Copy link

@derberg derberg left a comment

Choose a reason for hiding this comment

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

please add it like other docs to https://github.com/asyncapi/cli/tree/master/docs so later it is rendered in asyncapi.com/docs/tools/cli


AsyncAPI **anonymously** tracks command executions to improve the specification and tools, ensuring no sensitive data reaches our servers. It aids in comprehending how AsyncAPI tools are used and adopted, facilitating ongoing improvements to our specifications and tools.

Even though metrics collection is enabled by default, you can always [disable tracking](/../../../../github/docs/blob/main/METRICS_COLLECTION.md#how-to-disable-tracking) if you want to.
Copy link

Choose a reason for hiding this comment

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

Suggested change
Even though metrics collection is enabled by default, you can always [disable tracking](/../../../../github/docs/blob/main/METRICS_COLLECTION.md#how-to-disable-tracking) if you want to.
Even though metrics collection is enabled by default, you can always [disable tracking](#how-to-disable-tracking) if you want to.

this should be ok, as you link to anchor/section in the same document

@peter-rr
Copy link
Collaborator Author

please add it like other docs to https://github.com/asyncapi/cli/tree/master/docs so later it is rendered in asyncapi.com/docs/tools/cli

Apart from that, should be necessary to include some brief section regarding the metrics collection on the README file linked to METRICS_COLLECTION.md?

@peter-rr peter-rr requested review from derberg and smoya and removed request for derberg January 26, 2024 11:50
docs/metrics_collection.md Outdated Show resolved Hide resolved
docs/metrics_collection.md Outdated Show resolved Hide resolved
@peter-rr peter-rr requested a review from smoya January 31, 2024 17:48
@peter-rr peter-rr merged commit edb7f38 into smoya:feat/adoptionMetrics Feb 19, 2024
3 of 8 checks passed
@peter-rr peter-rr deleted the feat/adoptMetrics-metrics-docs branch February 19, 2024 11:21
Copy link
Collaborator Author

@peter-rr peter-rr left a comment

Choose a reason for hiding this comment

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

"How to disable tracking" section already updated. Ready to merge 🚀

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