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

Adjust documenation #159

Closed
14 tasks done
jridderbusch opened this issue Mar 27, 2024 · 0 comments · Fixed by #167
Closed
14 tasks done

Adjust documenation #159

jridderbusch opened this issue Mar 27, 2024 · 0 comments · Fixed by #167
Assignees
Labels
task/documentation Improvements or additions to documentation
Milestone

Comments

@jridderbusch
Copy link
Contributor

jridderbusch commented Mar 27, 2024

Documentation Update Request

Description

General remarks

  • Please update the Screenshots when the UI is finalized. The current logo is incorrect, and also the wording is not as desired.
  • Make sure that the screenshot matches the users persepctive. It is confusing if you are logged in as a servicepartner admin when you have a different view of the portal than a participant while explaining e.g. the User Management from a participant admins point of view. To give an example: In https://github.com/sovity/authority-portal/blob/v2.1.2/docs/product/user-documentation/Administration%20and%20Support.md the Usermanagement is explained but the menu bar shows the item "Provided Connectors" and in your profile the servicepartner role is displayed. Please log in as a particiapant admin with no application role when you are showing features that apply to that role. A different example where this mismatch also occurs is https://github.com/sovity/authority-portal/blob/v2.1.2/docs/product/user-documentation/Connect%20to%20the%20MDS.md
  • I'm missing a discription of the toggle bar used for switching the environment. Please add explainations for that (e.g. how to change the environment, which areas of the portal are affected by changing the toggle bar).
  • Please use appropriate names for organizations like "Your Organziation" etc. instead of "Evil corp" and make sure your not exposing your company or companies employees. Multiple of your screenshots show your name or the names of other sovity employees. Please try to be neutral here.
  • As I already mentioned in https://mobility-dataspace.online/?wpsc-section=ticket-list&ticket-id=188 I would very much prefer it if there was a clear separation between documentation that is relevant for the user and documentation that is relevant for application roles. It is not relevant for a non authority user to know how organizations are invited or rejected. Please separate this.
  • I'm missing an overall description of the portal, that also describes how the portal is structured. Maybe such a description could be added to the end of "Registration in the MDS Portal".
  • There is no documentation about the dashboard.

Administration and Support

  • The Chapter "User Management" is not intuitivly structured for me. I would start with explaining where a user can see his role, what roles exist and roughly what they can do and then I would go into detail explaining how a participant admin can invite new users and change a users role and status.
  • As already mentioned in General remarks the organization management is only relevant for authority-Roles and should therefor not be intertwined with the documentation for the customer. It should be part of a separate file.
  • The same is true for the chapter "Connector Overview". This information is only relevant for authority admins, authority users and the operator.

Connect to the MDS

Registration in MDS Portal

  • Wouldn't it make more sense to start with the organization registration and then go over the user invitation as this is the prerequisit for registering a user? From a users perspective there are two ways to get access to the portal: a) by registering his organization if the organization does not exists yet or b) by receiving an invitation from the authority.
  • If the organization is already registered the user has to ask his admin to invite him -> reference to the Administration chaptwr where the invite-Process should be explained.
@jridderbusch jridderbusch added the task/documentation Improvements or additions to documentation label Mar 27, 2024
@jridderbusch jridderbusch added this to the R 28.03. milestone Mar 27, 2024
@jridderbusch jridderbusch linked a pull request Apr 2, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
task/documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant