Proofreading - Environments and Deployment (New UI) #9473
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was a problem hiding this comment.
This is a great improvement on the original.
I've made some more suggestions, but it is always a balance between how far you go with changing things and the amount of time it will take.
As always, many of the comments are subjective - there is no right or wrong answer.
I feel that this is a really difficult thing to document - the UX seems to be inconsistent in where actions take place and whether they are icons or words. It surprises me for a newly designed UX. I think that we are doing the best job we can in explaining it - and your changes make it much clearer. Thanks.
| @@ -11,12 +11,14 @@ This feature is in Public Beta. For more information, see [Beta Releases](/relea | |||
| {{% /alert %}} | |||
|
|
|||
| {{% alert color="info" %}} | |||
| While this feature is in Beta, you can use the **New Theme** toggle to switch between this new UI and the [legacy UI](/developerportal/deploy/environments/). For apps running on Kubernetes, the new UI displays by default and cannot be toggled off. | |||
| While this feature is in Beta, you can use the **New Theme** toggle to switch between the new UI and the [legacy UI](/developerportal/deploy/environments/). For apps running on Kubernetes, the new UI is displayed by default and cannot be toggled off. | |||
| @@ -29,106 +31,124 @@ The **Environments** page has the following tabs: | |||
|
|
|||
| ### Overview Tab{#overview-tab} | |||
|
|
|||
| In the **Overview** tab, you can view information about your environments. | |||
| On the **Overview** tab, you can view information about and perform actions on your environments. | |||
| * Licensed badge – This is present if the environment is licensed. | ||
| * Environment status: | ||
| * The environment's name | ||
| * Studio Pro Target ({{< icon name="mendix-browser" >}}) – This is displayed if the environment is the designated Studio Pro target. For more information, see [Studio Pro Deployment Settings](/developerportal/deploy/studio-deployment-settings/). |
There was a problem hiding this comment.
Perhaps to make it clearer that this is an icon you could say something like:
"Whether this is the Studio Pro target"? Otherwise the customer could be looking for this particular text (at least that is what I did 😀)
| * {{< icon name="checkmark-circle-filled" color="green" >}} – The application in this environment is running. | ||
| * {{< icon name="subtract-circle-filled" color="gray" >}} – No application has been started yet in this environment, or it has been turned off. | ||
| * {{< icon name="alert-circle-filled" color="yellow" >}} – The application in this environment is experiencing some difficulties; check the alerts page or logs for more information. | ||
| * {{< icon name="subtract-circle-filled" color="gray" >}} – No application has been started yet in this environment, or the application has been turned off. |
| * {{< icon name="subtract-circle-filled" color="gray" >}} – No application has been started yet in this environment, or it has been turned off. | ||
| * {{< icon name="alert-circle-filled" color="yellow" >}} – The application in this environment is experiencing some difficulties; check the alerts page or logs for more information. | ||
| * {{< icon name="subtract-circle-filled" color="gray" >}} – No application has been started yet in this environment, or the application has been turned off. | ||
| * {{< icon name="alert-circle-filled" color="yellow" >}} – The application in this environment is experiencing some difficulties. Check the alerts page or logs for more information. |
There was a problem hiding this comment.
Yes, I find this clearer.
| @@ -172,37 +186,47 @@ Team members who have a role with **Cloud Access** can see which services are en | |||
|
|
|||
| Once a service has been enabled for an app, Technical Contacts can selectively enable it for each environment. For more information, see the [Services](/developerportal/deploy/environments-details/#services) section of the *Environment Details* page. | |||
|
|
|||
| ## Environment Settings | |||
| @@ -172,37 +186,47 @@ Team members who have a role with **Cloud Access** can see which services are en | |||
|
|
|||
| Once a service has been enabled for an app, Technical Contacts can selectively enable it for each environment. For more information, see the [Services](/developerportal/deploy/environments-details/#services) section of the *Environment Details* page. | |||
|
|
|||
| ## Environment Settings | |||
|
|
|||
| If you are the Technical Contact, you can use **Environment Settings** to choose the default target for the deployment package. If you do not select a target, the .mda package is built and uploaded without being deployed. | |||
There was a problem hiding this comment.
It's not clear to me how to get to this bit. Have I just missed it?
| If you are the Technical Contact, you can use **Environment Settings** to choose the default target for the deployment package. If you do not select a target, the .mda package is built and uploaded without being deployed. | ||
|
|
||
| {{< figure src="/attachments/deployment/mendix-cloud-deploy/environments-beta/manage-env-settings.png" alt="" >}} | ||
|
|
||
| ## Creating a Package {#create-package-wizard} |
There was a problem hiding this comment.
I think that there should probably be links to these package manipulation sections from the Deployment Package Actions section.
But I understand why they are separate sections and we don't try to describe them fully within that section.
| 3. In the **Select Revision** tab, select the branch revision. | ||
| 4. In the **Choose a Tag** tab, specify the version tag. This includes the major, minor, and patch version numbers. | ||
| 1. On the [Deployment Packages tab](#deployment-packages-tab), click **Create a Package**. This launches the **Create a Package** wizard. | ||
| 2. On the **Select Branch** tab, select the branch on which to base the build. |
|
|
||
| 1. Launch the wizard by choosing one of the following options: | ||
| * Select an environment to which you want to deploy a package by clicking the **Deploy** ({{< icon name="deploy" >}}) icon on the **Overview** tab. | ||
| * Select a package that you want to deploy by clicking the **Deploy** ({{< icon name="deploy" >}}) icon on the **Deployment Packages** tab, or by clicking **Promote** by a package name on the **Overview** tab. | ||
| 2. Perform one of the following actions, depending on whether you selected the package or the environment first: | ||
| * If you launched the wizard by selecting an environment, the first screen of the wizard is the **Select Package** tab. Use it to select a package from repository. | ||
| * If you launched the wizard by selecting an environment, the first screen of the wizard is the **Select Package** tab. Use it to select a package from the repository. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.