Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: switch quickstart note to warning #1912

Merged
merged 3 commits into from
Sep 5, 2024
Merged

docs: switch quickstart note to warning #1912

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
822f17a
docs: switch quickstart note to warning
nodegard Sep 4, 2024
8e6e578
docs: switch quickstart note to warning
nodegard Sep 4, 2024
113726e
Merge branch 'master' into docs/warning-quickstart
nodegard Sep 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/source/quickstart.rst
View file
Open in desktop
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