doc: improve documentation#294
Open
mlbiche wants to merge 5 commits into
Open
Conversation
added 5 commits
March 18, 2026 12:00
mlbiche
commented
Mar 18, 2026
|
|
||
| ## Default workflow | ||
|
|
||
| A new user that wants access to a system running NativeAuthenticator must first visit the signup page and create a new account with a username and password. By default, this user will not have access to the system, they will need the authorization of an admin to actually be able to login the system. Thus, after executing the signup, the user will receive a message letting them know that their information was sent to an admin. |
Author
There was a problem hiding this comment.
Moreover, I would like to improve the last sentence of this paragraph. It mentions a message received by the signed-up user, which is not clear. It can be understood as a send email, while it is not the case. When reading this, I searched how to configure the SMTP server, while the SMTP server is not required here. What is it meant by "receive a message"? Is it the success alert on top of the form?
Also, it is not clear how the information is sent to the admin user. At first glance, I thought it was by email, while it is not the case. In my opinion, the admin is not warned (which is just fine), it just sees the user to authorize in the Hub.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Thank you for this great authenticator plugin! I went through the installation of the authenticator on a project. However, I run into several issues that required me some search before reaching a working solution. Here are proposed improvements to the documentation that would have helped me to go through encountered issues.