Skip to content

Commit 92b6cb3

Browse files
Merge pull request #10346 from mendix/olu-change-plan-nov1025
Updating the change plan doc presentation
2 parents 8a32d44 + a7e92d0 commit 92b6cb3

2 files changed

Lines changed: 37 additions & 33 deletions

File tree

content/en/docs/deployment/mendix-cloud-deploy/change-plan.md

Lines changed: 34 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ To change an environment's plan, follow these steps:
4848
3. On the **Environments** page, click the **Overview** tab to view your environments.
4949
4. Find your target environment.
5050
5. Use the **Expand** ({{< icon name="chevron-down" >}}) toggle to view detailed information about each environment, such as the environment resources and deployed package.
51-
6. In the environment resource section, click **Change Plan**.
51+
6. In the environment resources section, click **Change Plan**.
5252
7. On the left side of the form that appears, review your current plan details. These include:
5353
* **Name** – Plan name.
5454
* **Environment** – Plan environment (such as, staging or acceptance).
@@ -69,6 +69,23 @@ To change an environment's plan, follow these steps:
6969
Changing plan consumes [Mendix Cloud Tokens](/control-center/cloud-tokens/#cloud-tokens). Only one plan change request can exist per environment at a time. As a result, new requests cannot be submitted for the same environment until the current one is completed.
7070
{{% /alert %}}
7171

72+
### Plan Change Request Status {#plan-change-status}
73+
74+
This diagram illustrates the lifecycle of a plan change request, from its submission to its final resolution (rejected, completed, or failed).
75+
76+
{{< figure src="/attachments/deployment/mendix-cloud-deploy/plan-change-status.png" >}}
77+
78+
A Technical Contact initiates the process by submitting a plan change request.
79+
80+
1. **Pending Approval** – After submission, the request enters a **Pending Approval** status. The request is then sent to a Mendix Admin for review.
81+
* If the Mendix Admin rejects the request, its status changes to **Rejected**.
82+
* If the Mendix Admin approves the request, the status changes to **Pending Schedule**.
83+
2. **Pending Schedule** – The plan change application is awaiting scheduling by the Technical Contact.
84+
3. **Scheduled** – Plan change is scheduled for the next maintenance window.
85+
4. **In Progress** – The plan change is actively being applied to the environment.
86+
5. **Completed** – Plan change was successfully applied to the environment
87+
6. **Failed** – The plan change did not complete successfully.
88+
7289
## Managing Plan Requests {#manage-plan-requests}
7390

7491
The **Change Requests** tab allows Technical Contacts to view all submitted plan change requests (both past and current) and track pending request status.
@@ -79,15 +96,26 @@ To access it:
7996
2. Click **Environments** on your app.
8097
3. Open the **Change Requests** tab.
8198

82-
For detailed information on the **Change Requests** tab, refer to the [Change Requests](/developerportal/deploy/environments/#change-requests) section in *Environments and Deployment*.
99+
Plan change requests have **Plan Upgrade** as the **Request Type**. For more information on the **Change Requests** tab, refer to the [Change Requests](/developerportal/deploy/environments/#change-requests) section in *Environments and Deployment*.
83100

84-
This diagram shows the progress of the request status from plan change submission to fulfilled (approved, rejected, completed, or failed):
101+
### Plan Change Requests Details {#change-requests-action}
85102

86-
{{< figure src="/attachments/deployment/mendix-cloud-deploy/plan-change-status.png" >}}
103+
Click **Details** on any plan change request to view the **name** of the requester, reviewer details and other request information, including:
104+
105+
* Status of the request
106+
* Current plan
107+
* Requested plan
108+
* Reason for resizing
109+
* Date of request creation
110+
* Date the request was scheduled
111+
* Request ID
112+
* Request type
113+
* App name
114+
* Environment
87115

88-
### Available Actions by Status {#available-actions-by-status}
116+
#### Available Actions by Status {#available-actions-by-status}
89117

90-
Depending on the request's status, Technical Contacts can perform the following actions:
118+
In the **Request Details** page, depending on the request's [status](#plan-change-status), Technical Contacts can perform the following actions:
91119

92120
* **Pending approval** – Click **Cancel Request** to cancel the entire request.
93121
* **Pending schedule** – Click **Cancel Request** to cancel the entire request, or click **Schedule Change** to set execution timing for when the approved plan will be applied. For more details on how to schedule a plan change, see [Scheduling a Plan Change](#scheduling-a-plan-change).

content/en/docs/deployment/mendix-cloud-deploy/environments.md

Lines changed: 3 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -176,39 +176,15 @@ If you are the [Technical Contact](/developerportal/general/app-roles/#technical
176176

177177
On the **Change Requests** tab, the Technical Contact can view details of all past and current [Change Plan](/developerportal/deploy/change-plan/) requests and perform certain actions based on the current request status.
178178

179-
For each submitted plan change request you can see the following information:
179+
For each submitted request, the following information is available:
180180

181181
* **Request Type** – Type of change requested
182182
* **Environment** – The environment the plan change was requested for (such as, acceptance or production)
183183
* **Current Plan** – The environment's existing plan
184184
* **Requested Plan** – The plan requested for change
185185
* **Submitted on** – Request submission date
186-
* **Status** – Current request state. This can be:
187-
* **Pending approval** – Awaiting Mendix Admin review
188-
* **Pending schedule** – Approved by Mendix Admin, but plan change application not yet scheduled by the Technical Contact
189-
* **Scheduled** – Plan change scheduled for the next maintenance window
190-
* **In progress** – Plan change is being applied
191-
* **Completed** – Mendix Admin has approved the change, Technical Contact has scheduled and applied the changes, and the new plan has been successfully applied to the environment
192-
* **Rejected** – Request was denied
193-
* **Failed** – Plan change did not complete successfully
194-
* **Action** – Shows more details of each plan request and provides options based on the request status. For more information, see [Change Requests Action](#change-requests-action)
195-
196-
#### Change Requests Action {#change-requests-action}
197-
198-
Click **Details** on any request to view the **name** of the requester and the reviewer and other request details, including:
199-
200-
* Status of the request
201-
* Current plan
202-
* Requested plan
203-
* Reasons for resizing
204-
* Date of request creation
205-
* Date the request was scheduled
206-
* Request ID
207-
* Request type
208-
* App name
209-
* Environment
210-
211-
For more information, refer to the [Available Actions by Status](/developerportal/deploy/change-plan/#available-actions-by-status) section in *Changing Your Plan in Mendix Cloud*.
186+
* **Status** – Current request state
187+
* **Action** – Shows more details of each request and provides options based on the request status
212188

213189
## Cloud Settings{#cloud-settings}
214190

0 commit comments

Comments
 (0)