Most of us that has worked on deployments and configuration of larger systems, have probably thought about naming standards. If used, how much easier it makes it to navigate the system, and easy to extend without having to be to creative finding unique names for your code and configuration.
As part of the Cognite Data Fusion Toolkit we have defined a naming standard that can be used for deployment of CDF projects.
Goals for the naming standard are:
- Readability and simplicity – it should be possible to understand what the name means without to much decoding of codes
- Establish a naming structure for your names and external-id used in your CDF project.
- Standardization across all CDF artifacts – structures and names should make it possible to understand all related artifacts in a data pipeline
- Scaling a project with new data pipelines, code and configuration should follow established structure
As you will have full control over all the configuration that is deployed using the Cognite Data Fusion Toolkit, you can extend and update the used names. Simplifying or extending, but with the Cognite Data Fusion Toolkit you will get help to enforce usage across data sources, code, configuration and supported solutions in CDF.
Documentation for naming standard: https://developer.cognite.com/sdks/toolkit/references/naming_conventions
Toolkit documentation: