-
Notifications
You must be signed in to change notification settings - Fork 1
docs: Update user authentication and api key creation instructions #340
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
base: main
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Minor comments and suggestions, thanks for taking this on otherwise!
A random password is generated for the newly created user which can later be changed. It is highly suggested to reset | ||
this password at once. To achieve that, copy it, log out from the `super-admin` initial user, and log in with the new | ||
credentials. Alternatively, if this user is created for a third person, make sure to save the initial password and share | ||
it with them directly, since it will not be possible to access again. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would write it as:
"""
A random password is generated for the newly created user. It is only shown once, so it should be copied and stored for later use. If the password needs to be changed, first log out from the User screen (or open AICA Studio in a new browser session), and log as the new user with the generated password. Then, change the password in the User screen by entering the generated password and the new desired password.
"""
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done.
Nice work here @SprGrf ! The only thing I would add here is a bit more "why". Let's assume that the user lands on this page for the first time and has no context and we have to explain from the very start what it is there for & why they would for example create a new user (you did a nice job capturing this for why APIs) |
Co-authored-by: Enrico Eberhard <[email protected]>
I agree, but don't you think the intro part, and right after the Users section, covers that? I mean there is not much more to say other than you need different user accounts for different access levels. |
@@ -35,17 +37,25 @@ identifier and can be granted a combination of [scopes](#scopes). | |||
:::note |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Line 13: "The AICA System License owner launching" -- can we call this "user" or something other than "owner"? See how "user" could also be confusing as the section is about user, but owners are a separate thing and are generally the non-developer license admin
I feel it's still missing some more context in the intro, especially, possibly more clarity on what you need the different access for/ that it isn't just another user on the license-- we had some previous confusion that adding a user physically adds another collaborative development user whom can develop etc-- whereas this feature is more for deployment |
Description
Minor updates in the user authentication guide, adding some details that were missing.
Review guidelines
Estimated Time of Review: 5 minutes
Checklist before merging: