Secret Detection Feature Naming
Problem to solve
This issue is being created to collect ideas about our Secret Detection nomenclature. We'll document proposed ideas and then determine whether or not it makes sense to update any current names prior to the launch of the pre-receive secret detection beta.
Customers and GitLab stakeholders need to be able to easily distinguish between various Secret Detection features/capabilities. Today, these are defined as:
- Pipeline Secret Detection. The first SD offering at GitLab and most widely adopted.
- Pre-receive secret detection. Experimental support recently launched for GitLab Dedicated. In the near future, this support will be expanded to beta for GitLab.com.
- Secret-detection as a platform-wide experience. This is related to some capabilities that are labeled in our documentation as Warnings for potential leaks in text content.
If Secret Detection features are going to be renamed, it will be easier to rename them sooner rather than later, and prior to the beta launch (currently aiming for 17.1).
Proposal
- Collect naming ideas in this issue prior to the receive beta launch.
- Seek a broad range of opinions and consider the arguments carefully.
- Do not allow naming to be a blocker for the release of new functionality, but determine whether any other naming conventions should be adopted.
GitLab's Feature Naming Guidelines -
Source: https://handbook.gitlab.com/handbook/product/gitlab-the-product/#naming-features
Factors in Picking a Name
- It should clearly express what the feature is, in order to avoid the AWS naming situation.
- It should follow usability heuristics when in doubt.
- It should be common in the industry.
- It should not overlap with any other existing concepts in GitLab.
- It should have as few words as possible (so people won’t use a shortened name).
- If you remove words from the name, it is still unique (helps to give it as few words as possible).
- We should also give products descriptive, not distinctive, names, and use prepositions when referring to third-party products and services in names. See our Product Principles for more information.