From 82284f3f736689ce45b3c68e42f3bfb3f8f2b628 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nina=20=C3=98deg=C3=A5rd?= Date: Thu, 5 Sep 2024 14:28:30 +0200 Subject: [PATCH] docs: switch quickstart note to warning (#1912) --- docs/source/quickstart.rst | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/source/quickstart.rst b/docs/source/quickstart.rst index 427fd99b6..4d6039f46 100644 --- a/docs/source/quickstart.rst +++ b/docs/source/quickstart.rst @@ -6,6 +6,10 @@ this quickstart we'll demonstrate the most common/recommended patterns. More det section: :ref:`CogniteClient `, :ref:`ClientConfig `, :ref:`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).