diff --git a/docs/README.md b/docs/README.md index bcaa74573..c5649c7a7 100644 --- a/docs/README.md +++ b/docs/README.md @@ -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...)
Comes with an integrated ng builder | @o3r/analytics
@o3r/build-helpers
@o3r/configuration
@o3r/core
@o3r/dev-tools
@o3r/extractors
@o3r/localization
@o3r/logger
@o3r/schematics
@o3r/testing | [COMPONENT_STRUCTURE](./components/COMPONENT_STRUCTURE.md)
[COMPONENT_STYLE_OVERRIDE](./components/COMPONENT_STYLE_OVERRIDE.md)
[CONTAINER_PRESENTER](./components/CONTAINER_PRESENTER.md)
[FIXTURES](./components/FIXTURES.md)
[NAMING_CONVENTION](./components/NAMING_CONVENTION.md)
[COMPONENT_REPLACEMENT](./components/COMPONENT_REPLACEMENT.md)
[CMS_ADAPTERS](./cms-adapters/CMS_ADAPTERS.md) | | @o3r/configuration | Configuration related features (CMS compatibility, Configuration override, store and debugging) | @o3r/core
@o3r/dev-tools
@o3r/logger
@o3r/testing | [OVERVIEW](./configuration/OVERVIEW.md)
[CONFIGURATION_SUPPORTED_EXTRACTOR](./configuration/CONFIGURATION_SUPPORTED_EXTRACTOR.md)
[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)
[DEVELOPER](./core/DEVELOPER.md)
[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)
[DEVELOPER](./core/DEVELOPER.md)
[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
@o3r/dev-tools | [DYNAMIC_CONTENT](./dynamic-content/DYNAMIC_CONTENT.md)
[LOCALHOST_MIDDLEWARE](./dynamic-content/LOCALHOST_MIDDLEWARE.md) | @@ -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
@o3r/configuration
@o3r/core
@o3r/dev-tools
@o3r/localization
@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
@o3r/dynamic-content
@o3r/extractors
@o3r/schematics | [THEME](./styling/THEME.md)
[TYPOGRAPHY](./styling/TYPOGRAPHY.md)
[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
@o3r/schematics | [POST_MESSAGE_INTERCEPTOR](./testing/POST_MESSAGE_INTERCEPTOR.md)
[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) | diff --git a/docs/telemetry/README.md b/docs/telemetry/PRIVACY_NOTICE.md similarity index 100% rename from docs/telemetry/README.md rename to docs/telemetry/PRIVACY_NOTICE.md diff --git a/packages/@o3r/extractors/src/core/wrapper.ts b/packages/@o3r/extractors/src/core/wrapper.ts index ab92b3f1e..aef701f40 100644 --- a/packages/@o3r/extractors/src/core/wrapper.ts +++ b/packages/@o3r/extractors/src/core/wrapper.ts @@ -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 }; diff --git a/packages/@o3r/schematics/src/utility/wrapper.ts b/packages/@o3r/schematics/src/utility/wrapper.ts index 024deddfa..b572491b6 100644 --- a/packages/@o3r/schematics/src/utility/wrapper.ts +++ b/packages/@o3r/schematics/src/utility/wrapper.ts @@ -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 }; diff --git a/packages/@o3r/telemetry/README.md b/packages/@o3r/telemetry/README.md index fc1453a3d..4ee7b0b41 100644 --- a/packages/@o3r/telemetry/README.md +++ b/packages/@o3r/telemetry/README.md @@ -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 +