From 4de24a7d88a8553851681bf558f7c1d07fc43bb3 Mon Sep 17 00:00:00 2001
From: Jon <jonathon.lockwood@networkedweb.com>
Date: Mon, 7 Apr 2025 14:21:19 +0930
Subject: [PATCH] docs(user): Roles Initial

ref: #712 closes #683
---
 docs/projects/centurion_erp/user/access/index.md  |  2 ++
 docs/projects/centurion_erp/user/access/role.md   | 12 ++++++++++++
 docs/projects/centurion_erp/user/core/markdown.md |  2 +-
 mkdocs.yml                                        |  2 ++
 4 files changed, 17 insertions(+), 1 deletion(-)
 create mode 100644 docs/projects/centurion_erp/user/access/role.md

diff --git a/docs/projects/centurion_erp/user/access/index.md b/docs/projects/centurion_erp/user/access/index.md
index 53145a76..09c5105a 100644
--- a/docs/projects/centurion_erp/user/access/index.md
+++ b/docs/projects/centurion_erp/user/access/index.md
@@ -15,6 +15,8 @@ The Access module provides the multi-tenancy for this application. Tenancy is or
 
 - [Organization](./organization.md)
 
+- [Roles](./role.md)
+
 - [Team](./team.md)
 
 
diff --git a/docs/projects/centurion_erp/user/access/role.md b/docs/projects/centurion_erp/user/access/role.md
new file mode 100644
index 00000000..90642c9a
--- /dev/null
+++ b/docs/projects/centurion_erp/user/access/role.md
@@ -0,0 +1,12 @@
+---
+title: Roles
+description: Centurion ERP Roles for RBAC User documentation
+date: 2025-04-07
+template: project.html
+about: https://github.com/nofusscomputing/centurion_erp
+---
+
+A Role is used as part of authorization. This provides for a feature known as Role Base Access Control or RBAC for short. Roles are assigned permissions to conduct an action with the user or group being assigned a role. This in turn allows a user to conduct an action. By default no user has any permission to conduct any action. This means that once a user is assigned a role with a/many permission(s) they will be able to act according to the assigned permissions. If a user is assigned multiple roles, they will have the permissions of all roles combined.
+
+!!! warning
+    This feature is currently behind feature flag `2025-00003` and will remain so until roles are production ready. see [#551](https://github.com/nofusscomputing/centurion_erp/issues/551) for more details
diff --git a/docs/projects/centurion_erp/user/core/markdown.md b/docs/projects/centurion_erp/user/core/markdown.md
index d4c42289..031c90f4 100644
--- a/docs/projects/centurion_erp/user/core/markdown.md
+++ b/docs/projects/centurion_erp/user/core/markdown.md
@@ -96,7 +96,7 @@ A Model link is a reference to an item within the database. Supported model link
 | projectstate| `$project_state-<id>` |
 | projecttask| `$-<id>` |
 | projecttype| `$-<id>` |
-| role| `$role-<id>` |
+| [role](../access/role.md)| `$role-<id>` |
 | service| `$service-<id>` |
 | software| `$software-<id>` |
 | softwarecategory| `$-<id>` |
diff --git a/mkdocs.yml b/mkdocs.yml
index b662245e..27f0e04a 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -167,6 +167,8 @@ nav:
 
         - projects/centurion_erp/user/access/organization.md
 
+        - projects/centurion_erp/user/access/role.md
+
         - projects/centurion_erp/user/access/team.md
 
       - Assistance: