NatLabRockies / NatLabRockies/H2Integrate
Add analytics to the H2I docs
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 26
- Forks
- 44
- Avg merge
- 3d 22h
- Merged PRs (30d)
- 16
Description
Add analytics to the H2I docs
Other NREL products, like Floris and the reference hybrid designs, use Google Analytics successfully to track users.
We should implement that here for H2Integrate.
Proposed solution
Implement Google Analytics for H2I.
Alternatives considered
After a brief discussion with @RHammond2, we identified that Google saves a lot of data from users, which might be a privacy concern.
However, there are no other free full-featured alternatives, despite Rob searching a good amount.
It is reasonable to proceed with Google Analytics, knowing they capture a large amount of data on users.
Additional context
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the H2I documentation site's configuration and reviewing how Floris and the reference hybrid designs integrate Google Analytics. Confirm the selected integration and privacy implications, then verify that analytics are active for H2I documentation users.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100