diff --git a/site/guide/validation/_add-edit-artifact-types.qmd b/site/guide/validation/_add-edit-artifact-types.qmd index 82be0f5cf..56ed90138 100644 --- a/site/guide/validation/_add-edit-artifact-types.qmd +++ b/site/guide/validation/_add-edit-artifact-types.qmd @@ -38,8 +38,9 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> 4. Make your desired changes to the artifact type's details: - - **Name** - - **Description** + - **Name**, **Description**, and **Slug** — Edit the artifact type's details and click **Save Details** to apply your changes. You can rename any artifact type, including the default ones.[^edit-details] + - The name is shown everywhere the artifact type appears, such as the sidebar, artifact lists and filters, and workflows. Dashboard charts filtered to the artifact type by name are updated to the new name. Names must be unique within your organization and 255 characters or fewer. + - The slug identifies the artifact type in permissions and in links to its settings. Slugs must be unique within your organization and use only lowercase letters, numbers, and dashes. - **Fields** — Select the default artifact fields that should appear on this type of artifact and click **Save Fields** to apply your changes.[^edit-fields-callout] - **Record Fields Display**[^edit-record-fields-config] — Select which upstream record fields^[[Edit inventory fields](/guide/inventory/edit-inventory-fields.qmd)] to display as read-only under the Inventory Record Information section on artifacts of this type and click **Save Record Fields Configuration** to apply your changes. - **Artifact Statuses** — Configure the statuses available to this artifact type.^[[Manage artifact type statuses](#manage-artifact-type-statuses)] @@ -70,6 +71,13 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> - [Manage record stakeholder types](/guide/configuration/manage-record-stakeholder-types.qmd) - [Manage roles](/guide/configuration/manage-roles.qmd) +[^edit-details]: + + ::: {.callout title="Changing a slug keeps the artifact type's permissions."} + Roles keep the same permissions to create, update, and view artifacts of the type, and existing artifacts and links to them are not affected. Bookmarked links to the artifact type's settings that include the old slug no longer open it. + + ::: + [^edit-fields-callout]: ::: {.callout title="Only default fields are available to be selected in this view."} @@ -114,6 +122,7 @@ b. Make your desired changes to the artifact type's details and permissions. Most changes are saved automatically. + - For **Name**, **Description**, and **Slug**, click **Save Details** to apply changes. - For **Fields** configuration, click **Save Fields** to apply changes. - For **Record Fields Display** configuration, click **Save Record Fields Configuration** to apply changes. diff --git a/site/guide/validation/manage-artifact-types.qmd b/site/guide/validation/manage-artifact-types.qmd index ca670618a..adc3b6d1a 100644 --- a/site/guide/validation/manage-artifact-types.qmd +++ b/site/guide/validation/manage-artifact-types.qmd @@ -25,6 +25,8 @@ Policy Exception Limitation : Inherent weaknesses or constraints of the record itself that cannot be fully resolved; definitions under which the record's results should be interpreted with caution. +You can rename any artifact type, including these defaults, so that it matches the terminology your organization uses.^[[Edit artifact types](#edit-artifact-types)] +
::: {.callout-button .pl4 .nt4}