Skip to content

Commit

Permalink
docs(telemetry): add missing documentation for telemetry (#1480)
Browse files Browse the repository at this point in the history 
## Related issues

- 🐛 Fixes #1447
  • Loading branch information
@matthieu-crouzet
matthieu-crouzet committed Mar 13, 2024
2 parents 0234135 + b12120a commit 6d2eb40
Show file tree
Hide file tree
Showing 5 changed files with 9 additions and 4 deletions.
5 changes: 3 additions & 2 deletions docs/README.md
View file
Expand Up @@ -13,7 +13,7 @@ The documentation is sorted by topic but in the table below, you shall find the
| @o3r/chrome-devtools | Chrome plugin to debug your Otter application | N/A | [chrome-devtools](./dev-tools/chrome-devtools.md) |
| @o3r/components | Component related features (Component replacement, CMS compatibility, helpers, pipes, debugging developer tools...) <br/> Comes with an integrated ng builder | @o3r/analytics <br/> @o3r/build-helpers <br/> @o3r/configuration <br/> @o3r/core <br> @o3r/dev-tools <br/> @o3r/extractors <br/> @o3r/localization <br/> @o3r/logger <br> @o3r/schematics <br/> @o3r/testing | [COMPONENT_STRUCTURE](./components/COMPONENT_STRUCTURE.md) <br/> [COMPONENT_STYLE_OVERRIDE](./components/COMPONENT_STYLE_OVERRIDE.md) <br/> [CONTAINER_PRESENTER](./components/CONTAINER_PRESENTER.md) <br/> [FIXTURES](./components/FIXTURES.md) <br/> [NAMING_CONVENTION](./components/NAMING_CONVENTION.md) <br/> [COMPONENT_REPLACEMENT](./components/COMPONENT_REPLACEMENT.md) <br/> [CMS_ADAPTERS](./cms-adapters/CMS_ADAPTERS.md) |
| @o3r/configuration | Configuration related features (CMS compatibility, Configuration override, store and debugging) | @o3r/core <br/> @o3r/dev-tools <br/> @o3r/logger <br/> @o3r/testing | [OVERVIEW](./configuration/OVERVIEW.md) <br/> [CONFIGURATION_SUPPORTED_EXTRACTOR](./configuration/CONFIGURATION_SUPPORTED_EXTRACTOR.md) <br/> [CMS_ADAPTERS](./cms-adapters/CMS_ADAPTERS.md) |
| @o3r/core | Foundation for all the packages (interfaces, core helpers) and schematics to generate your components/services etc. | N/A | [START_NEW_APPLICATION](./core/START_NEW_APPLICATION.md) <br/> [DEVELOPER](./core/DEVELOPER.md) <br/> [OTTER_ANGULAR_TOOLS](./core/OTTER_ANGULAR_TOOLS.md) | |
| @o3r/core | Foundation for all the packages (interfaces, core helpers) and schematics to generate your components/services etc. | N/A | [START_NEW_APPLICATION](./core/START_NEW_APPLICATION.md) <br/> [DEVELOPER](./core/DEVELOPER.md) <br/> [OTTER_ANGULAR_TOOLS](./core/OTTER_ANGULAR_TOOLS.md) |
| @o3r/design | Tools to generate theme from design materials | N/A | [TECHNICAL_DOCUMENTATION](./design/TECHNICAL_DOCUMENTATION.md) |
| @o3r/dev-tools | Various CLI scripts to help your CI/CD and your dependency management | N/A | [DEV_TOOLS](./dev-tools/DEV_TOOLS.md) |
| @o3r/dynamic-content | Mechanism to retrieve media and data depending on the host or a server specific url | @o3r/core <br/> @o3r/dev-tools | [DYNAMIC_CONTENT](./dynamic-content/DYNAMIC_CONTENT.md) <br/> [LOCALHOST_MIDDLEWARE](./dynamic-content/LOCALHOST_MIDDLEWARE.md) |
Expand All @@ -29,7 +29,8 @@ The documentation is sorted by topic but in the table below, you shall find the
| @o3r/storybook | Utilities to integrate the Storybook framework to your Otter project | @o3r/components <br/> @o3r/configuration <br/> @o3r/core <br/> @o3r/dev-tools <br/> @o3r/localization <br/> @o3r/styling | |
| @o3r/stylelint-plugin | In-house stylint plugins to use in your own eslint configuration | N/A | [stylelint-plugin](./linter/stylelint-plugin.md) |
| @o3r/styling | Styling framework to apply a theme on an Otter application at build time and runtime to support CMS customization | @o3r/core <br/> @o3r/dynamic-content <br/> @o3r/extractors <br/> @o3r/schematics | [THEME](./styling/THEME.md) <br/> [TYPOGRAPHY](./styling/TYPOGRAPHY.md) <br/> [CMS_ADAPTERS](./cms-adapters/CMS_ADAPTERS.md) |
| @o3r/telemetry | A set of helpers to retrieve tool usage metrics. | N/A | [PRIVACY NOTICE](./telemetry/PRIVACY_NOTICE.md) |
| @o3r/testing | Testing (e2e, unit test) utilities to help you build your own E2E pipeline integrating visual testing | @o3r/localization <br/> @o3r/schematics | [POST_MESSAGE_INTERCEPTOR](./testing/POST_MESSAGE_INTERCEPTOR.md) <br/> [UNIT_TESTS_SETUP](./testing/UNIT_TESTS_SETUP.md) |
| @o3r/third-party | Bridge to communicate with third parties via an iFrame solution | N/A | [A/B Testing](./ab-testing/AB_TESTING.md) |
| @o3r/vscode-extension | Various in house VSCode extensions to help you with the development of your Otter application with this IDE (automated generated Otter components etc.) | N/A | [vscode-extension](../apps/vscode-extension/README.md) |
| @o3r/vscode-extension | Various in house VSCode extensions to help you with the development of your Otter application with this IDE (automated generated Otter components etc.) | N/A | [vscode-extension](../apps/vscode-extension/README.md) |
| @o3r/eslint-config-otter | Recommended eslint configuration for Otter project | @o3r/eslint-plugin | [eslint-config](./linter/eslint-config.md) |
0 docs/telemetry/README.md → docs/telemetry/PRIVACY_NOTICE.md
View file
File renamed without changes.
2 changes: 1 addition & 1 deletion packages/@o3r/extractors/src/core/wrapper.ts
View file
Expand Up @@ -40,7 +40,7 @@ export const createBuilderWithMetricsIfInstalled: BuilderWrapper = (builderFn) =
message: `
Would you like to share anonymous data about the usage of Otter builders and schematics with the Otter Team at Amadeus ?
It will help us to improve our tools.
For more details and instructions on how to change these settings, see https://github.com/AmadeusITGroup/otter/blob/main/docs/telemetry/README.md.
For more details and instructions on how to change these settings, see https://github.com/AmadeusITGroup/otter/blob/main/docs/telemetry/PRIVACY_NOTICE.md.
`,
default: false
};
Expand Down
2 changes: 1 addition & 1 deletion packages/@o3r/schematics/src/utility/wrapper.ts
View file
Expand Up @@ -72,7 +72,7 @@ export const createSchematicWithMetricsIfInstalled: SchematicWrapper = (schemati
message: `
Would you like to share anonymous data about the usage of Otter builders and schematics with the Otter Team at Amadeus ?
It will help us to improve our tools.
For more details and instructions on how to change these settings, see https://github.com/AmadeusITGroup/otter/blob/main/docs/telemetry/README.md.
For more details and instructions on how to change these settings, see https://github.com/AmadeusITGroup/otter/blob/main/docs/telemetry/PRIVACY_NOTICE.md.
`,
default: false
};
Expand Down
4 changes: 4 additions & 0 deletions packages/@o3r/telemetry/README.md
View file
Expand Up @@ -11,3 +11,7 @@ This package is an [Otter Framework Module](https://github.com/AmadeusITGroup/ot

A set of helpers to retrieve tool usage metrics.

## Privacy notice

https://github.com/AmadeusITGroup/otter/blob/main/docs/telemetry/PRIVACY_NOTICE.md

0 comments on commit 6d2eb40

Please sign in to comment.