UX: Communication of Clickhouse status [Optimize]

Release notes

• When setting up and enabling ClickHouse there are multiple steps invoiced and considerations to take.
• After ClickHouse is enabled, that UI needs to contextually communicate when it is being used.

This UX & Technical Writing issue should be the SSOT for all UI design and copy.

Problem to solve

1. When enabling ClickHouse, the user first needs to view the documentation on how to setup ClickHouse
2. Before enabling ClickHouse in the UI, the user needs to be made aware of...
   • the expected data volume requirements for this feature (related comment)
   • the list of features/metrics that will use CH (related comment)
3. After ClickHouse is enabled, the users need to contextually see which metrics are using CH
4. When Disabling ClickHouse... (TBD)

Proposal

WIP...

Iteration path (source)

• Global setting to enable/disable CH integration.
• Global, feature-specific setting to enable/disable CH integration.
• Group-level feature-specific switch to enable/disable CH integration.
• adding the status of CH configuration in the Analytics settings - section under settings > general > analytics will show the CH configuration status.
• add an indication in the Contribution Analytics UI that the data is based on CH and not PG.

Intended users

• Sasha (Software Developer)
• Sidney (Systems Administrator)

Feature Usage Metrics

Does this feature require an audit event?

This page may contain information related to upcoming products, features and functionality. It is important to note that the information presented is for informational purposes only, so please do not rely on the information for purchasing or planning purposes. Just like with all projects, the items mentioned on the page are subject to change or delay, and the development, release, and timing of any products, features, or functionality remain at the sole discretion of GitLab Inc.

Questions

• When disabling ClickHouse, are there any things the user needs to be made aware of? For example, will any "work" get lost? Will anything need to be "re-indexed" etc.? Do we need to provide another docs link on how to completely "uninstall" it if needed?
• What things can go wrong? How much error handling should we define?

TODOs

• Solicit feedback from the team to make sure all constraints are defined
• Create UI proposals
• Solicit feedback from Technical Writing
• Solicit feedback from the team again