Skip to main content
Solved

Toolkit naming alignment

  • 6 May 2024
  • 1 reply
  • 53 views

Forum|alt.badge.img+2

Hey team,

I was wondering if there is going to be an alignment on what we call this tool across the many places it is referenced? I’ve found these 5 so far:

  • This hub group: CDF Toolkit cdf-tk and project templates
  • github: cdf-project-templates
  • pypi: cognite-toolkit
  • command line: cdf-tk

I’m personally a fan of cdf-tk.

  • cognite-toolkit is too broad (doesn’t include InRobot, Maintain, f25e).
  • cdf-project-templates is too many words for a CLI.
  • project-templates is too broad.

Best answer by palronning

Hi @Ben Petree , thanks for pointing this out.

Cognite Data Fusion Toolkit is the official name, but it is ok to refer to it as CDF Toolkit or just “the Toolkit” if it makes sense in context. We are removing “templates” from the name and try to follow this pattern:

In documentation and community: Use full name. 

  • The Hub Group Name should be Cognite Data Fusion Toolkit. @Anita Hæhre , can you please rename it?

In source code and packet distribution: Use “toolkit”

In command-line: 

  • CLI usability dictates simplicity and convenience. We like cdf-tk too. It is a convenient shorthand for the full name. 
View original
Did this topic help you find an answer to your question?

Hi @Ben Petree , thanks for pointing this out.

Cognite Data Fusion Toolkit is the official name, but it is ok to refer to it as CDF Toolkit or just “the Toolkit” if it makes sense in context. We are removing “templates” from the name and try to follow this pattern:

In documentation and community: Use full name. 

  • The Hub Group Name should be Cognite Data Fusion Toolkit. @Anita Hæhre , can you please rename it?

In source code and packet distribution: Use “toolkit”

In command-line: 

  • CLI usability dictates simplicity and convenience. We like cdf-tk too. It is a convenient shorthand for the full name. 

Reply


Cookie Policy

We use cookies to enhance and personalize your experience. If you accept you agree to our full cookie policy. Learn more about our cookies.

 
Cookie Settings