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.

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

New User Management documentation #2541

Merged

Conversation

frascuchon
Copy link
Member

@frascuchon frascuchon commented Mar 14, 2023

A first iteration of changes in new user management doc sections.

  • Still missing HOWTO delete users and workspaces using the API

Copy link
Member

@dvsrepo dvsrepo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it's looking good!

Once the corrections are added, I'd propose the following heading and changes to the titles (didn't want to mess it up with suggestions):

User management model

User

Workspace

Use workspaces from the Python client

Old Python client section I would move it to the bottom

Default user

Add new users

### Prepare the database

Creating an admin user

Creating an annotator user

Create new workspaces and add annotators to workspaces

Setup an HTTP client with an admin auth header

Call the create workspace endpoint

Select annotators and link them using their ids

Migrate users from the users.yaml file

Migrate users with docker-compose

Copy link
Member

@nataliaElv nataliaElv left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just added some suggestions to improve readability. Feel free to commit/discard.

Co-authored-by: Natalia Elvira <[email protected]>
Co-authored-by: Daniel Vila Suero <[email protected]>
Co-authored-by: José Francisco Calvo <[email protected]>
Co-authored-by: José Francisco Calvo <[email protected]>
Co-authored-by: David Berenstein <[email protected]>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@dvsrepo @davidberenstein1957 please can you take a look and review this file?

@frascuchon frascuchon changed the title Wip User Management New User Management documentation Mar 21, 2023
# 'updated_at': '2023-03-16T11:17:35.462774'}]
````

## Delete a user
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is deleting a user only possible with Python or is there a CLI command as well?

Copy link
Member

@jfcalvo jfcalvo Mar 22, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Right now it's only possible using the new API endpoint that's added by #2564

Specifically this one: https://github.com/argilla-io/argilla/pull/2564/files#diff-590aac8b7993f90c6c131b210dc9d87acc51108782eb710eb882ee8c32f9a30bR100

docs/_source/getting_started/quickstart.ipynb Outdated Show resolved Hide resolved
docs/_source/getting_started/quickstart.ipynb Outdated Show resolved Hide resolved
@@ -109,7 +109,7 @@ To get started you just need to run the docker image with following command:
```

This will run the latest quickstart docker image with 2 users `argilla` and `team`. The password for these users is
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If I remember correctly, these users were admin and argilla in a different file. Are these different here?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You're totally right. These should be admin and argilla. Thanks!

quickstart.README.md Outdated Show resolved Hide resolved
@frascuchon frascuchon marked this pull request as ready for review March 22, 2023 14:48
@frascuchon frascuchon merged commit 657c4e7 into feat/add-basic-database-support Mar 22, 2023
@frascuchon frascuchon deleted the docs-about-new-user-management branch March 22, 2023 14:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants