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

Adding project FAQ #82

Merged
merged 4 commits into from
Dec 17, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 33 additions & 0 deletions docs/faq.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# FAQ

## What happens when I enable conda-anaconda-telemetry?

When the `conda-anaconda-telemetry` plugin is installed and enabled, the plugin will collect additional
jezdez marked this conversation as resolved.
Show resolved Hide resolved
information about how conda is being used. This is then submitted to the channel servers that
are currently configured via HTTP request headers. This allows channel owners to gain additional
insights about how their channels are being used.
jezdez marked this conversation as resolved.
Show resolved Hide resolved

## What data is tracked by this plugin?

We currently collect the following information when this plugin is installed:

- Installed [virtual packages](https://docs.conda.io/projects/conda/en/stable/dev-guide/plugins/virtual_packages.html)
(e.g. `glibc` version or your current architecture specifications e.g. `m1`)
jezdez marked this conversation as resolved.
Show resolved Hide resolved
- Installed packages in the active environment (e.g. the output of `conda list`)
- Configured channels (e.g. `defaults` or `conda-forge`)
- System information (e.g. `conda-build` version or the command currently being run)
- When `conda search` is run, we track the packages that are being searched for
- When `conda install` or `conda create` is run, we track the packages that are being installed that are
specified at the command line (e.g. for the command`conda install package-a package-b`, `package-a` and
jezdez marked this conversation as resolved.
Show resolved Hide resolved
`package-b` will be tracked)

## Which commands are you tracking?

We only track commands which make network requests. This includes the following:
jezdez marked this conversation as resolved.
Show resolved Hide resolved

- `conda search`
- `conda install`
- `conda update`
- `conda create`
- `conda remove`
- `conda notices`
1 change: 1 addition & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,5 +33,6 @@ conda remove --name base conda-anaconda-telemetry
```{toctree}
:hidden:

faq
dev/index
```
Loading