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

Add documentation for Analytics #1931

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

Lash-L
Copy link
Contributor

@Lash-L Lash-L commented Sep 19, 2023

Proposed change

I was curious why my custom integration wasn't showing up with analytics data and I couldn't find any development information on it. I realized it was because it wasn't included in the brands repository. I created this documentation page to make it clearer what information is available and some of the context behind it

Type of change

  • Document existing features within Home Assistant
  • Document new or changing features which there is an existing pull request elsewhere
  • Spelling or grammatical corrections, or rewording for improved clarity
  • Changes to the backend of this documentation
  • Removed stale or deprecated documentation

Additional information

  • This PR fixes or closes issue: fixes #
  • Link to relevant existing code or pull request:

Copy link
Member

@rytilahti rytilahti left a comment

Choose a reason for hiding this comment

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

Looks fair enough to me, just a couple of comments that might be worth taking into account.


Data for core integrations can be found [here](https://analytics.home-assistant.io/integrations/).

It is important to note that only an estimated 1/4th to 1/3rd of users have their analytics enabled - so your user base is more than likely multiple times larger than reported.
Copy link
Member

Choose a reason for hiding this comment

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

I'm not sure if it's necessary to include this paragraph, especially if there is no mention how it's substantiated.

When attempting to communicate with manufacturers, it can be helpful to be equipped with information about what kind of a user base your integration has.

For a user's installation of your integration to count the following conditions must be met:
1) The integration must be set up.
Copy link
Member

Choose a reason for hiding this comment

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

Use markdown enumeration, as it will otherwise bundle everything together as can be seen in the preview.

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.

None yet

2 participants