Skip to content

Commit

Permalink
docs: switch quickstart note to warning (#1912)
Browse files Browse the repository at this point in the history
  • Loading branch information
nodegard authored Sep 5, 2024
1 parent 8a8ed12 commit 82284f3
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions docs/source/quickstart.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@ this quickstart we'll demonstrate the most common/recommended patterns. More det
section: :ref:`CogniteClient <class_client_CogniteClient>`, :ref:`ClientConfig <class_client_ClientConfig>`,
:ref:`GlobalConfig <class_client_GlobalConfig>`, and :ref:`credential_providers:Credential Providers`.

.. warning::
Ensure that credentials are stored and handled securely by not hard-coding it or storing them in a text file. All the below examples
are using and referencing environment variables to store this sensitive information.

Instantiate a new client from a configuration file
--------------------------------------------------
Use this code to instantiate a client using a configuration file in order to execute API calls to Cognite Data Fusion (CDF).
Expand Down

0 comments on commit 82284f3

Please sign in to comment.