Skip to content

Commit

Permalink
(CAT-1807) Remove all reference of analytics from the docs
Browse files Browse the repository at this point in the history
  • Loading branch information
david22swan committed Apr 12, 2024
1 parent fe0f662 commit 811449b
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 67 deletions.
62 changes: 0 additions & 62 deletions docs/pdk_install.md
Original file line number Diff line number Diff line change
Expand Up @@ -296,65 +296,3 @@ $env:http_proxy="http://user:[email protected]:port"
$env:https_proxy="http://user:[email protected]:port"
```

## Analytics

### PDK data collection

PDK collects usage data to help us understand how it's being used and how we can
improve it. You can opt out of data collection at any time; see the section
below about opting out.

We collect these values for every analytics event:

- A random non-identifying user ID. This ID is shared with Puppet Bolt® analytics, if
you've installed Bolt and enabled analytics.
- PDK installation method (`package` or `gem`).
- Version of PDK.
- Operating system and version.

For every successful command line invocation of PDK, we collect:

- The PDK command executed, such as `pdk new module` or ``pdk validate``.
- Anonymised command options and arguments.
- The version of Ruby used to execute the command.
- The output formats for the command.
- `PDK_*` environment variables and their values, if set.
- Whether a template repository, if used, is `default` or `custom` — we do not
record the path to the template repo itself.
- If the default template repo is used, we collect events for each file
rendered, recording whether the file is `unmanaged`, `deleted`,
`customized`, or `default`. For customized files, we do not record what
changed, only that it was changed in the `.sync.yml` file.

> **Note:** All arguments and non-Boolean option values, except `--puppet-version` are redacted in our collected data
Invalid commands are submitted as a distinct analytics events with the arguments
and option values redacted.

To see the data PDK collects, add the `--debug` option to any `pdk` command. We
test the analytics calls strictly to ensure that no unexpected data is
accidentally passed in.

### Opting out of PDK data collection

The first time you run PDK, it asks you if you want to opt out of data
collection. To opt out of data collection after that, edit the `analytics.yml`
file, setting the `disabled` key to `true`.

```
disabled: true
```

The location of this configuration file depends on your operating system and
configuration:

- For most \*nix systems, where the `$XDG_CONFIG_HOME` variable is set:
`${XDG_CONFIG_HOME}/puppet/analytics.yml`.
- For most macOS systems, where the `$XDG_CONFIG_HOME` variable is not set:
`~/.config/puppet/analytics.yml`.
- For Windows: `%LOCALAPPDATA%/puppet/analytics.yml`.

You can also opt out of analytics by setting the environment variable
`PDK_DISABLE_ANALYTICS=true`. This is useful if you are using PDK in your CI
system.
10 changes: 5 additions & 5 deletions docs/pdk_reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,11 +40,11 @@ Usage:
pdk get config <key>
```

For example: `pdk config get user.analytics.disabled`
For example: `pdk config get user.module_defaults.author`

|Argument|Description|Value|Default|
|--------|-----------|-----|-------|
|`<key>`|The name, or name prefix, of the setting key to retrieve. Raises an error if the setting does not exist.|The full name of the setting, such as `user.analytics.disabled`. Alternatively, the beginning of the setting name, which retrieves all settings that match. For example, `user.analytics` returns all settings that start with user.analytics`user.analytics`.|If no `<key>` is passed, the command returns all configuration keys that it finds.|
|`<key>`|The name, or name prefix, of the setting key to retrieve. Raises an error if the setting does not exist.|The full name of the setting, such as `user.module_defaults.author`. Alternatively, the beginning of the setting name, which retrieves all settings that match. For example, `user.module_defaults` returns all settings that start with `user.module_defaults`.|If no `<key>` is passed, the command returns all configuration keys that it finds.|

## `pdk remove config` command

Expand All @@ -64,7 +64,7 @@ pdk remove config [--all] <key>

|Argument|Description|Value|Default|
|--------|-----------|-----|-------|
|`<key>`|Required. The configuration key to delete values for.|The full name of the setting, such as `user.analytics.disabled`. Alternatively, the beginning of the setting name, which retrieves all settings that match. For example, `user.analytics` returns all settings that start with user.analytics`user.analytics`.|No default. The `<key>` is required.|
|`<key>`|Required. The configuration key to delete values for.|The full name of the setting, such as `user.module_defaults.author`. Alternatively, the beginning of the setting name, which retrieves all settings that match. For example, `user.module_defaults` returns all settings that start with `user.module_defaults`.|No default. The `<key>` is required.|
|`<value>`|Required. The value to delete for the specified key. To delete all values, use the `--all` option instead of specifying values.|One or more specified values for the given configuration key.|No default. Either a `<value>` or the `--all` option is required for normal usage.|
|`--all`|Empties all values for the given key.|None.|When this option is passed, empties all values for the specified key.|

Expand All @@ -79,11 +79,11 @@ Usage:
pdk set config [--type|--as <typename>] [--force] <key> [<value>]
```

For example: `pdk set config --type boolean user.analytics.disabled false`
For example: `pdk set config --type boolean user.module_defaults.author john_doe`

|Argument|Description|Value|Default|
|--------|-----------|-----|-------|
|`<key>`|Required. The configuration key to set, change, or add values for.|The full name of the setting, such as `user.analytics.disabled`.|No default. The `<key>` is required.|
|`<key>`|Required. The configuration key to set, change, or add values for.|The full name of the setting, such as `user.module_defaults.author`.|No default. The `<key>` is required.|
|`<value>`|Required. The value to set for the specified key.|One or more valid values for the specified `<key>`.|No default. One or more values are required.|
|`–-add`|Treats a user-defined configuration key as a multi-value key.|None.|This option treats the value as a list of values.|
|`--force`|Runs the command, making literal changes without prompting for confirmation.|None.|By default, prompts are enabled.|
Expand Down

0 comments on commit 811449b

Please sign in to comment.