Include required roles/permissions in documentation

[Gareth Cantrell]

One thing that would be incredibly useful is to include which roles/permissions are required for various functions, especially in the configuration guides.

The current roles and permissions in Hornbill are to a large degree undocumented and require a hit-and-miss approach to figuring out what permission gives access to what functionality.

Using "Working Time Calendars" (https://docs.hornbill.com/esp-config/customize/working-time-calendars) as an example, add a further heading for Roles and Permissions detailing which roles grant access to this and what functions within that configuration are controlled by which permissions.

[will.good]

100% agree

[Berto2002]

+1. However, I note there are lists of each right and their Roles in the API documentation like Supplier Manager API Reference - Application Rights. Are we just after assurance that this can also be read in terms of UI utilisation with some more detailed descriptions?

[Gareth Cantrell]

@Berto2002 in terms of configuration, I don't generally think of viewing API documentation when I'm in the context of non-API work, so having the relevant information at the appropriate point in the documentation would be of greater help as it requires less context-switching (and searching).

[James Ainsworth]

Hi @Gareth Cantrell

Thanks for your feedback.

At the top of some of our new documents within docs.hornbill.com there is already a section titled Before you begin.  This section will generally include any roles or rights that are needed to work with the features described in the document.  This is continuing work and you should see more of these Before you begin sections on documents where appropriate.  

If there is a particular area within the configuration guides that doesn't include this and you would like to know what roles and rights are needed, please ask and we can prioritise updating the documentation for that area.  I'll have a look at the Working Time Calendars that you mentioned.