Skip to content

Commit

Permalink
docs: Minor docs tweaks (kedro-org#266)
Browse files Browse the repository at this point in the history
Minor docs tweaks

Signed-off-by: Simon Brugman <[email protected]>
Co-authored-by: Juan Luis Cano Rodríguez <[email protected]>
  • Loading branch information
2 people authored and Peter Bludau committed Aug 27, 2023
1 parent 1b3e938 commit 3b53085
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 13 deletions.
2 changes: 1 addition & 1 deletion kedro-docker/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ def count_truthy(elements: List[Any]) -> int:
We use a branching model that helps us keep track of branches in a logical, consistent way. All branches should have the hyphen-separated convention of: `<type-of-change>/<short-description-of-change>` e.g. `feature/awesome-new-feature`

| Types of changes | Description |
| ---------------- | --------------------------------------------------------------------------- |
|------------------|-----------------------------------------------------------------------------|
| `docs` | Changes to the documentation of the plugin |
| `feature` | Non-breaking change which adds functionality |
| `fix` | Non-breaking change which fixes an issue |
Expand Down
24 changes: 12 additions & 12 deletions kedro-telemetry/RELEASE.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,21 +6,21 @@

The `kedro-telemetry` plugin asks for consent to collect command run data. However, when we introduced functionality to understand the size of projects by counting the number of datasets, pipelines and nodes, the plugin did not verify consent, leading to the plugin collecting data without user consent. This bug affects users with `kedro-telemetry >= 0.2.2` installed, 22.5% of our user base.

<img width="730" alt="Screenshot 2023-04-04 at 16 17 43" src="https://user-images.githubusercontent.com/43755008/229840293-fea91403-b02d-4221-9167-71d3a6196cc5.png">
<img width="730" alt="kedro-telemetry version piechart" src="https://user-images.githubusercontent.com/43755008/229840293-fea91403-b02d-4221-9167-71d3a6196cc5.png">

Here is an example of what was collected.

|Description|What we received|
|-|-|
|_(Hashed)_ Package name| c7cd944c28cd888904f3efc2345198507...|
|_(Hashed)_ Project name| a6392d359362dc9827cf8688c9d634520e...|
|`kedro` project version| 0.18.4|
|`kedro-telemetry` version| 0.2.3|
|Python version| 3.8.10 (default, Jun 2 2021, 10:49:15) |
|Operating system used| darwin |
| Number of datasets | 7 |
| Number of pipelines | 2 |
| Number of nodes | 12 |
| Description | What we received |
|---------------------------|-----------------------------------------|
| _(Hashed)_ Package name | c7cd944c28cd888904f3efc2345198507... |
| _(Hashed)_ Project name | a6392d359362dc9827cf8688c9d634520e... |
| `kedro` project version | 0.18.4 |
| `kedro-telemetry` version | 0.2.3 |
| Python version | 3.8.10 (default, Jun 2 2021, 10:49:15) |
| Operating system used | darwin |
| Number of datasets | 7 |
| Number of pipelines | 2 |
| Number of nodes | 12 |

A fix must go beyond just releasing a bugfix for `kedro-telemetry`. Additionally, we will:

Expand Down

0 comments on commit 3b53085

Please sign in to comment.