Merge branch 'main' of https://github.com/Unleash/unleash

website/docs/reference/change-requests.md

@@ -0,0 +1,77 @@
+---
+title: Change requests
+---
+
+:::info
+
+The change requests feature was introduced in **Unleash 4.18.0**, and is currently an enterprise only feature in beta
+with a select few customers. If you're an unleash enterprise customer, please contact us if you'd like to try out this 
+feature. 
+
+:::
+
+Feature flagging is a powerful tool, and because it's so powerful, you sometimes need to practice caution. The ability to have complete control over your production environment comes at the cost of the potential to make mistakes in production. Change requests were introduced in version 4.18.0 to alleviate this fear. Change requests allow you to group changes together and apply them to production at the same time, instead of applying changes directly to production. This allows you to make multiple changes to feature toggles and their configuration and status (on/off) all at once, reducing the risk of errors in production.
+
+Our goal is developer effeciency, but we also recognize that we have users and customers in highly regulated industries, governed by law and strict requirements. Therefore, we have added a capability to change requests that will allow you to enforce the _4 eyes principle_.
+
+## Change request configuration
+
+The change request configuration can be set up per project, per environment. This means that you can have different change request configurations for different environments, such as production and development. This is useful because different environments may have different requirements, so you can customize the change request configuration to fit those requirements. However, this also means that you cannot change toggles across projects in the same change request.
+
+Currently there are two configuration options for change requests:
+* **Enable change requests** - This is a boolean value that enables or disables change requests for the project and environment.
+* **Required approvals** - This is an integer value that indicates how many approvals are required before a change request can be applied. Specific permissions are required to approve and apply change requests.
+
+The change request configuration can be set up in the project settings page: 
+
+![Change request configuration](/img/change-request-configuration.png)
+
+
+## Change request flow
+
+Once a change request flow is configured for a project and environment, you can no longer directly change the status of a toggle. Instead, you will be asked to put your changes into a draft. The change request flow handles the following scenarios: 
+
+* Updating the status of a toggle in the environment
+* Adding a strategy to the feature toggle in the environment
+* Updating a strategy of a feature toggle in the environment
+* Deleting a strategy from a feature toggle in the environment
+
+The flow can be summarized as follows:
+
+![Change request flow](/img/change-request-flow.png)
+
+Once a change is added to a draft, the draft needs to be completed before another change request can be opened. The draft is personal to the user that created the change request draft, until it is sent for review. Once changes are added to draft, the user will have a banner in the top of the screen indicating that a draft exists. The state of a change request can be one of the following: 
+
+* **Draft** - The change request is in draft mode, and can be edited by the user that created the draft.
+* **In review** - The change request is in review mode, and can be edited by the user that created the draft. If editing ocurrs, all current approvals are revoked
+* **Approved** - The change request has been approved by the required number of users.
+* **Applied** - The change request has been applied to the environment. The feature toggle configuration is updated.
+* **Cancelled** - The change request has been cancelled by the user/admin.
+
+![Change request banner](/img/change-request-banner.png)
+
+Once a change request is sent to review by the user who created it, it becomes available for everyone in the change request tab in the project. 
+
+From here, you can navigate to the change request overview page. This page will give you information about the changes the change request contains, the state the change request is in, and what action needs to be taken next.
+
+![Change request banner](/img/change-request-overview.png)
+
+From here, if you have the correct permissions, you can approve and apply the change request. Once applied the changes will be live in production.
+
+## Change request permissions
+
+As a result of adding change requests, we have added three new environment specific permissions: 
+* Approve change request
+* Apply change request
+* Skip change request
+
+These permisssions can be used to compose [project roles](../how-to/how-to-create-and-assign-custom-project-roles.md).
+
+Once you have created a custom project role that has the correct permissions, you can assign it to a user or group of users in the project settings access section. These users will then assume permissions according to the role they have been assigned.
+
+### Circumventing change requests
+
+In the event that you need API access to directly turn something off without going through the change request procedure, you can leverage the skip change request permission. The holder of this permission can bypass the change request procedure and directly change the feature toggle configuration, depending on the other permissions they have. The skip change request permission is only valid for circumventing the change request flow, you still need to explicitly grant the user the permissions for the actions you'd like to perform. IE: Changing a toggle status in an environment, or adding a strategy to a toggle in an environment.
+
+
+

website/sidebars.js

@@ -337,6 +337,7 @@ module.exports = {
                         'reference/technical-debt',
                         'reference/unleash-context',
                         'reference/unleash-proxy',
+                        'reference/change-requests',
                     ],
                 },
             ],