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: update metrics documentation #29

Closed
12 tasks
SgtPooki opened this issue Jan 2, 2023 · 1 comment · Fixed by #35
Closed
12 tasks

docs: update metrics documentation #29

SgtPooki opened this issue Jan 2, 2023 · 1 comment · Fixed by #35
Assignees

Comments

@SgtPooki
Copy link
Member

SgtPooki commented Jan 2, 2023

The work tracking doc should exist in notion, but policy, standards, and processes should all be defined in the GitHub repo.

Metrics documentation requirements make me think that the majority of docs existing in GitHub is the right decision:

  • The public can access them easily
  • The Public/devs can post questions/updates directed at documentation easily and publicly
  • The public can be informed of updates and track update history easily
  • Current and future devs can find this information and update it easily while not violating the above three items.

Tasks

  • create docs in ipfs-shipyard/ignite-metrics
    • privacy policy based on https://github.com/ipfs/ipfs-companion/blob/main/PRIVACY-POLICY.md
    • Breakdown of metrics collection intentions (opt-out and what that entails)
      • This is what the user will see
      • This is what will be collected
      • This is what won't be collected
    • basic dev consumption docs on how to use for react/non-react packages (README)
    • Link to above docs in README.md
  • create single notion page under our team notion page - https://pl-strflt.notion.site/Telemetry-b005d4f217f44db3986902c67d922cf4
    • Link to all metrics items (past, present, future)
    • Link to above pages in ignite-metrics (will probably be in PR)
    • Specify team methodology and ethics for metrics collection and tools/UI used for doing so
      • specify process to follow for updating metrics.
    • Update Notion doc to address comments from Steve
@SgtPooki
Copy link
Member Author

SgtPooki commented Jan 5, 2023

@BigLep Note that I indicated in ipfs/ipfs-gui#125 (comment) that I would specify in the README of ignite-metrics (this repo) that I would cover

  • This is what will be collected
  • This is what won't be collected

but those items will be in each repo's ./docs/telemetry/CollectedData.md documentation as specified in the ./docs/telemetry/CollectionPolicy being added in #35

For the "- This is what the user will see" item, that should be covered by the documents in #35

SgtPooki added a commit that referenced this issue Jan 13, 2023
* feat: add telemetry documentation

fixes #29
fixes ipfs/ipfs-gui#125

* docs: fix markdown link to FAQs document

* docs: add FAQ for turning telemetry completely off

* docs: minor updates about user data

* docs: add UI examples and steps for adding telemetry to repo

* docs: reordering and rephrasing

* Update CollectedData.template.md

* Update docs/telemetry/CollectionPolicy.md

Co-authored-by: Nishant Arora <1895906+whizzzkid@users.noreply.github.com>

* Update docs/telemetry/CollectionPolicy.md

Co-authored-by: Nishant Arora <1895906+whizzzkid@users.noreply.github.com>

* Update docs/telemetry/CollectionPolicy.md

Co-authored-by: Nishant Arora <1895906+whizzzkid@users.noreply.github.com>

* Update docs/telemetry/CollectionPolicy.md

Co-authored-by: Nishant Arora <1895906+whizzzkid@users.noreply.github.com>

* Update docs/telemetry/CollectionPolicy.md

Co-authored-by: Nishant Arora <1895906+whizzzkid@users.noreply.github.com>

* docs: additional clarifications and updates

* docs: more updates

* Update README.md

Co-authored-by: Marcin Rataj <lidel@lidel.org>

* Update docs/telemetry/CollectedData.template.md

Co-authored-by: Marcin Rataj <lidel@lidel.org>

* Update docs/telemetry/CollectionPolicy.md

Co-authored-by: Marcin Rataj <lidel@lidel.org>

* Update docs/telemetry/CollectionPolicy.md

Co-authored-by: Marcin Rataj <lidel@lidel.org>

* chore: update countly url

* chore(docs): update collectedData.template links

* chore: use UPPER_SNAKE_CASE for telemetry docs

* Update docs/telemetry/FAQs.md

Co-authored-by: Marcin Rataj <lidel@lidel.org>

* chore(docs): fix links

* chore(docs): add ipfs-gui team under lead maintainer

* chore: remove multi-toggle images

* chore: grammar

* chore: update example screenshot of ipfs-companion

* fix: exports

Co-authored-by: Nishant Arora <1895906+whizzzkid@users.noreply.github.com>
Co-authored-by: Marcin Rataj <lidel@lidel.org>
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 a pull request may close this issue.

1 participant