diff --git a/docs/source/general_concepts.rst b/docs/source/general_concepts.rst index a37e57ae1..1e06eea84 100644 --- a/docs/source/general_concepts.rst +++ b/docs/source/general_concepts.rst @@ -11,6 +11,9 @@ The user authenticated to interact with the |company| platform. The user has access to the resources and capabilities that are also available on the |platform|. For a |platform| specific description of capabilities, please refer to the :xref:`docs_main_entry`. +> 👍 Tip +>For collaborative teams using our SDK, we recommend creating shared service accounts and creating SSH keys for those shared accounts. For example, to have several people create ontologies, datasets, and projects programatically, create an email account for use with Encord (for example, encord-admins@mycompany.com) and generate an SSH for that email account. + Dataset ======= The space where the data itself lives. diff --git a/docs/source/tutorials/projects.rst b/docs/source/tutorials/projects.rst index 7ab060afc..c8bbda52b 100644 --- a/docs/source/tutorials/projects.rst +++ b/docs/source/tutorials/projects.rst @@ -122,6 +122,9 @@ Users can be added to an existing project using their emails. You can specify the role of the users being added using the :class:`.ProjectUserRole` enum. You can find more details of the different roles in the :class:`doc-strings <.ProjectUserRole>`. +> 👍 Tip +>For collaborative teams using our SDK, we recommend creating shared service accounts and creating SSH keys for those shared accounts. For example, to have several people create ontologies, datasets, and projects programatically, create an email account for use with Encord (for example, encord-admins@mycompany.com) and generate an SSH for that email account. + Below is an example of how to add two new annotators to the project. Note how all users get assigned the same role. diff --git a/encord/user_client.py b/encord/user_client.py index 829a164c1..1f7b4bc29 100644 --- a/encord/user_client.py +++ b/encord/user_client.py @@ -83,9 +83,9 @@ def get_dataset( self, dataset_hash: str, dataset_access_settings: DatasetAccessSettings = DEFAULT_DATASET_ACCESS_SETTINGS ) -> Dataset: """ - Get the Project class to access project fields and manipulate a project. + Get the Dataset class to access dataset fields and manipulate a dataset. - You will only have access to this project if you are one of the following + You only have access to this project if you are one of the following * Dataset admin