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

Decide on the best place to publish information about kedro-telemetry to our users #509

Closed
yetudada opened this issue Jan 8, 2024 · 6 comments
Labels
technical documentation A technical documentation for workarounds or technical decision telemetry

Comments

@yetudada
Copy link
Contributor

yetudada commented Jan 8, 2024

Description

A lot of open-source projects will detail their telemetry collection practices in their documentation. This task is to consult @stichbury about the best placement of our information about kedro-telemetry. Do we leave it on the README.md or move this document to our documentation so it's more visible for users?

@yetudada yetudada added technical documentation A technical documentation for workarounds or technical decision telemetry labels Jan 8, 2024
@stichbury
Copy link
Contributor

I think this is probably a case of "Why not both?". I think it would make sense to have a better coverage of telemetry in the main docs (this could be in the plugins section perhaps) and link that through to the README.

I would not put any more in the first place telemetry is mentioned since that's getting in the way of most new users creating a first project, but instead possibly put a description in the glossary or a section in the plugins docs (which need some work anyway, so we could make better sections for Kedro-team maintained plugins like telemetry). This would summarise briefly but use the README as the main resource.

@astrojuanlu
Copy link
Member

I support adding this to our docs on top of the README, which is what most other projects do #510 (comment)

@astrojuanlu
Copy link
Member

Also, the current link https://github.com/kedro-org/kedro-plugins/tree/main/kedro-telemetry#privacy-notice is broken (it lands on the README but there's no "privacy notice" header anymore). We need a more permanent place for this.

I think it would make sense to have a better coverage of telemetry in the main docs (this could be in the plugins section perhaps) and link that through to the README.

I'm +1 on this. Any objections @merelcht @rashidakanchwala @NeroOkwa ? (So that we can log the decision)

@astrojuanlu
Copy link
Member

I'll take that as a yes. Let's place this information on https://docs.kedro.org/.

@stichbury
Copy link
Contributor

In closing this, I'll assume you're ticketing the work itself separately.

@astrojuanlu
Copy link
Member

Yep, #508

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
technical documentation A technical documentation for workarounds or technical decision telemetry
Projects
Archived in project
Development

No branches or pull requests

4 participants