Merge main into staging

site/Makefile

@@ -3,23 +3,26 @@ SRC_DIR := _source/developer-framework
 DEST_DIR_NB := notebooks
 DEST_DIR_PYTHON := _site/validmind
 DEST_DIR_TESTS := tests
+GIT_BRANCH := $(shell git rev-parse --abbrev-ref HEAD)
 
 # Define .PHONY target for help section
-.PHONY: help clean clone notebooks python-docs docs-site deploy-demo deploy-prod release-notes
+.PHONY: help clean clone notebooks python-docs docs-site deploy-demo deploy-demo-branch delete-demo-branch deploy-prod release-notes
 
 # Help section
 help:
 	@echo "Available targets:"
-	@echo "  clean          Remove the _source/ directory"
-	@echo "  clone          Clone the developer-framework repository into _source/"
-	@echo "  notebooks      Copy Jupyter notebooks into notebooks/"
-	@echo "  python-docs    Copy the Python library docs into _site/validmind"
-	@echo "  get-source     Get all source files (clean, clone, notebooks, python-docs)"
-	@echo "  docs-site      Get all source files and render the docs site with Quarto"
-	@echo "  deploy-demo    Render the docs site & deploy to docs-ci-cd-demo and clear cache"
-	@echo "  deploy-prod    Render the docs site & deploy to docs-ci-cd-prod and clear cache"
-	@echo "  help           Display this help message (default target)"
-	@echo "  release-notes  Generate release notes from pull requests since latest tag and update _quarto.yml"
+	@echo "  clean                Remove the _source/ directory"
+	@echo "  clone                Clone the developer-framework repository into _source/"
+	@echo "  notebooks            Copy Jupyter notebooks into notebooks/"
+	@echo "  python-docs          Copy the Python library docs into _site/validmind"
+	@echo "  get-source           Get all source files (clean, clone, notebooks, python-docs)"
+	@echo "  docs-site            Get all source files and render the docs site with Quarto"
+	@echo "  deploy-demo          Deploy docs demo site to s3://docs-ci-cd-demo/site/"
+	@echo "  deploy-demo-branch   Deploy docs demo site to s3://docs-ci-cd-demo/site/pr_previews/$(GIT_BRANCH)/"
+	@echo "  delete-demo-branch   Delete docs demo site in s3://docs-ci-cd-demo/site/pr_previews/$(GIT_BRANCH)/"
+	@echo "  deploy-prod          Deploy docs prod site to s3://docs-ci-cd-prod/site/"
+	@echo "  help                 Display this help message (default target)"
+	@echo "  release-notes        Generate release notes from pull requests since latest tag and update _quarto.yml"
 
 # Clean up source directory
 clean:
@@ -82,9 +85,19 @@ deploy-demo:
 		echo "You're not on the docs-demo branch, no action taken."; \
 	else \
 		echo "\nDeploying docs-demo site ..."; \
-		quarto render && aws s3 sync ./_site s3://docs-ci-cd-demo/site/ --delete && aws cloudfront create-invalidation --distribution-id E38AINJY5CYN6P --paths "/*" --no-cli-pager > /dev/null; \
+		quarto render && aws s3 sync ./_site s3://docs-ci-cd-demo/site/ && aws cloudfront create-invalidation --distribution-id E38AINJY5CYN6P --paths "/*" --no-cli-pager > /dev/null; \
 	fi
 
+# Deploy PR branch to https://docs-demo.vm.validmind.ai/
+deploy-demo-branch:
+	@quarto render && aws s3 sync ./_site s3://docs-ci-cd-demo/site/pr_previews/$(GIT_BRANCH)/ --delete && aws cloudfront create-invalidation --distribution-id E38AINJY5CYN6P --paths "/*" --no-cli-pager > /dev/null; 
+	@echo "\nDeployed to https://docs-demo.vm.validmind.ai/pr_previews/$(GIT_BRANCH)/index.html"
+
+# Delete PR branch on https://docs-demo.vm.validmind.ai/
+delete-demo-branch:
+	@aws s3 rm s3://docs-ci-cd-demo/site/pr_previews/$(GIT_BRANCH)/ --recursive && aws cloudfront create-invalidation --distribution-id E38AINJY5CYN6P --paths "/*" --no-cli-pager > /dev/null; 
+	@echo "\nDeleted https://docs-demo.vm.validmind.ai/pr_previews/$(GIT_BRANCH)/"
+
 # Deployment to https://docs.validmind.ai/
 deploy-prod:
 	@if [ "`git rev-parse --abbrev-ref HEAD`" != "prod" ]; then \

site/guide/configuration/manage-groups.qmd

@@ -2,10 +2,10 @@
 title: "Manage groups"
 ---
 
-Invite new users and assign users to specific groups to maintain access control and efficient user management within your organization via the {{< var validmind.platform >}}. 
+Groups are segments of users with the ability to view models associated with that group. Access to granular features in the {{< var validmind.platform >}} within a group's set of models is further defined by roles and permissions.
 
-::: {.callout-important}
-Ensure that the group details align with your requirements for access control and group management.
+::: {.callout}
+Users must belong to a default group of `All`, and can belong to mulitple groups.
 :::
 
 ::: {.prereq}

site/guide/configuration/manage-permissions.qmd

@@ -4,7 +4,7 @@ date: last-modified
 tbl-cap-location: bottom
 ---
 
-Use permissions to streamline and secure access control within your organization. Add or remove roles for specific permissions and ensure that individuals have access to the right features.
+Permissions dictate user access controls within the {{< var validmind.platform >}}, and are associated with specific roles. Assign granular permissions to roles according to your organization's custom requirements.
 
 ::: {.prereq}
 
@@ -17,8 +17,8 @@ Use permissions to streamline and secure access control within your organization
 
 ## Steps
 
-::: {.callout-important title="Be careful when modifying permissions to ensure they align with the role's intended responsibilities and access requirements."}
-Please note that the `Customer Admin` role has the highest level of access and as such, its permissions cannot be modified.
+::: {.callout-important title="When assigning permissions to roles, ensure they align with the role's intended responsibilities and access requirements."}
+Please note that the `Customer Admin` role has the highest level of access and as such its permissions cannot be modified.
 :::
 
 1. In the left sidebar, click **{{< fa gear >}} Settings**. 

site/guide/configuration/manage-roles.qmd

@@ -2,7 +2,7 @@
 title: "Manage roles"
 ---
 
-Managing roles is crucial for maintaining a secure and well-organized environment. Assign, update, and view permissions for different roles, and ensure that each role has appropriate access to the resources they need. 
+Roles are a named set of permissions that determine your users' access to features within the {{< var vm.platform >}} based on your organization's structure. Create and update roles, and verify that each role has appropriate access to the resources they need. 
 
 ::: {.prereq}
 
@@ -13,16 +13,32 @@ Managing roles is crucial for maintaining a secure and well-organized environmen
 
 :::
 
-## Steps
+## Add or update roles
 
-::: {.callout-important}
-Be careful when modifying permissions to ensure they align with the role's intended responsibilities and access requirements.
+::: {.callout-important title="Role permissions and role assignments determines a user's level of access."}
+Please note that the `Customer Admin` role has the highest level of access and as such, it cannot be cannot be modified.
 :::
 
 1. In the left sidebar, click **{{< fa gear >}} Settings**. 
 
 {{< include _manage-roles.qmd >}}
 
+### Rename existing roles
+
+To rename a role after it has been created:
+
+1. In the left sidebar, click **{{< fa gear >}} Settings**. 
+
+2. Under User Permissions, select **{{< fa user-group >}} Roles**.
+
+3. Select the role you want to rename.
+
+4. On the role's detail view, click on the title of the role. 
+
+5. Type in the new name of the role.
+
+6.  Click **Save** to apply your changes.
+
 
 <!-- FOOTNOTES -->
 

site/guide/configuration/manage-users.qmd

@@ -2,7 +2,8 @@
 title: "Manage users"
 date: last-modified
 ---
-Ensure smooth operations and maintain secure access controls by managing users. The {{< var validmind.platform >}} offers robust features for managing user profiles, roles, groups, and invitations effectively. 
+
+Invite new users and review your current users from within the user directory. Users belong to groups which determine which models they can see, and have roles with attached permissions which define the level of access they have to features.
 
 ::: {.prereq}
 

site/guide/model-inventory/register-models-in-inventory.qmd

@@ -34,12 +34,13 @@ If no additional fields are required on registration for your models:
 | Field | Description | 
 |---:|---|
 | Model Name | The name of your model. |
+| Group | (conditional) If you belong to multiple user groups,[^3] select the group that can see the model. |
 | What type of model is it? | Whether the model is a new model, or an existing model. |
-| Template (conditional) | New models require a **Template**[^3] to be selected. |
+| Template (conditional) | New models require a **Template**[^4] to be selected. |
 | Model Status (conditional) | Existing models require a **Model Status** to be selected. |
 | Business Unit | Business unit associated with the model. |
 | Use Case | The model's use case. |
-| Is it a vendor model? (optional) | If the model is a vendor model, toggle **Is Vendor Model**.[^4] |
+| Is it a vendor model? (optional) | If the model is a vendor model, toggle **Is Vendor Model**.[^5] |
 | Vendor Name (conditional) | If the model is a vendor model, provide the vendor's name. |
 | Purpose | Explain what the model will be used for. |
 | Preliminary Risk Tier | Assign a preliminary risk tier. |
@@ -70,6 +71,8 @@ If additional fields are required on model registration for your organization:
 
 [^2]: [Manage model inventory fields](manage-model-inventory-fields.qmd)
 
-[^3]: [Working with documentation templates](/guide/model-documentation/working-with-documentation-templates.qmd)
+[^3]: [Manage groups](/guide/configuration/manage-groups.qmd)
 
-[^4]: Learn more about [vendor models](/about/glossary/glossary.qmd#vendor-model)
+[^4]: [Working with documentation templates](/guide/model-documentation/working-with-documentation-templates.qmd)
+
+[^5]: Learn more about [vendor models](/about/glossary/glossary.qmd#vendor-model)

site/training/training-for-administrators.qmd

@@ -186,7 +186,7 @@ When you are done, click [{{< fa chevron-right >}}]() to continue.
 
 :::: {.columns}
 ::: {.column width="30%" .pr4 .f2}
-Assign roles to users to define their responsibilities and grant permissions to groups to set access levels.
+Assign roles to users to define responsibilities based on your organization's structure, granting them acccess to features within the {{< var validmind.platform >}}.
 :::
 
 ::: {.column width="70%" .bl .pl4 .f3}