Proofreading task for the beta ui #9481
Conversation
There was a problem hiding this comment.
Hi @OlufunkeMoronfolu
There is some great stuff in this PR and the updated images look great. The information is now, I think, much clearer and more straightforward.
I have made a few comments - some on things which were there already and I noticed on a quick reading of the doc.
Sorry I'm not around to answer any questions you have immediately, but I'll discuss any changes with you as soon as I'm back.
Thanks for doing this - it is a great improvement.
| @@ -43,18 +43,17 @@ When your app is running, you can perform the following actions: | |||
| * **More Options**: | |||
| * **Show Logged in Users** – This shows all users who are logged in to your app. | |||
| * **Change Admin Password** – This changes the password for the built-in [administrator](/refguide/administrator/) account. The new password is applied immediately, without the need for a restart, and forces the administrator to pick up any new [roles](/refguide/administrator/#user-role) assigned in the app deployment package. | |||
| * **View Live Log** – This shows a live log for your application. It is identical to the **View Live Log** button on the [Logs](/developerportal/operate/logs/) page. | |||
| * **Show Debugger Information** – This shows the settings needed to connect the debugger in Studio Pro to your app. For more information on debugging in the cloud, see [How To Debug Microflows Remotely](/refguide/debug-microflows-remotely/). | |||
| * **View Live Logs** – This shows a live log of your application. It is identical to the **View Live Log** action on the [Logs](/developerportal/operate/logs/) page. | |||
There was a problem hiding this comment.
I can see why you want to avoid referring to a UX element, but I think button is OK here. Perhaps "it has the same action as the View Live Log button"?
There was a problem hiding this comment.
I see your point. I adopted your suggestion but with a different verb.
content/en/docs/deployment/mendix-cloud-deploy/environments-details-new.md
Show resolved
Hide resolved
content/en/docs/deployment/mendix-cloud-deploy/environments-details-new.md
Outdated
Show resolved
Hide resolved
| * **Plan** – the type of plan covered by your license (for more information, see the [Overviews](/developerportal/deploy/environments-details/#overviews) section below) | ||
| * **Instances** – a summary of the number and memory allocation of instances of the environment (for more information, see the [Scaling](#scaling) section below) |
There was a problem hiding this comment.
Have these really gone? I see they are described under Scaling, so I guess there is nothing now in the Application Status section.
Should there be a header for the "Application Status" section?
There was a problem hiding this comment.
The plan is no longer part of the application status, similar to the instances. Instead, it is now under the Plan Details. I will add some more explanation to that section.
However, you are right, we should include a header for the Application Status, this will also ensure consistency with the other sections that heave headers. I'll add it right away.
|
|
||
| At the bottom of the page, there are three sections showing the deployment package details, plan details, and license. These are described in detail below in the [Overviews](#overviews) section. | ||
| At the bottom of the **General** tab, there are three additional sections, which are described in detail in the [Overviews](#overviews) section below. | ||
|
|
||
| #### Clearing an Environment {#clear-environment} |
There was a problem hiding this comment.
This is one too many hashes and looks odd when built.
There was a problem hiding this comment.
This section fits better under the new heading, "Stooped App Actions". I have moved it there, but it still has deep nesting. Let me know if this placement works and whether we should keep the current structure.
content/en/docs/deployment/mendix-cloud-deploy/environments-details-new.md
Show resolved
Hide resolved
content/en/docs/deployment/mendix-cloud-deploy/environments-details-new.md
Outdated
Show resolved
Hide resolved
| * Our engineering team has already been notified about the failed task. If you are still experiencing issues, please create a support ticket with [Mendix Support](https://support.mendix.com/hc/en-us) | ||
| * **Incomplete** – the maintenance task was unsuccessful and no changes were applied | ||
| * You can operate the environment as usual. Our engineering team should already have been alerted about the incomplete task and will take the appropriate action (which may involve rescheduling the task). | ||
| * You can operate the environment as usual. Our engineering team has received an alerted about the incomplete task and will take the appropriate action (which may involve rescheduling the task) |
There was a problem hiding this comment.
I know we usually use present tense, and "should have" feels weak and doesn't need the "already". However, I think I might prefer "will be" or "will have been", even though they are not present tense.
There was a problem hiding this comment.
Okay, rewritten to show that.
| @@ -556,9 +550,9 @@ If you want to add, edit, or delete a tag, make the change on the **Tags** tab a | |||
|
|
|||
| ## The Services Tab {#services} | |||
|
|
|||
| You can enable and disable custom services for individual environments of your app. The service that you want to enable must have been enabled for the app by its [Technical Contact](/developerportal/general/app-roles/#technical-contact). For more information, see [Services](/developerportal/deploy/environments/#services). | |||
| In the **Services** tab, the [Technical Contact](/developerportal/general/app-roles/#technical-contact) decides which custom services to be used in each environment of the app. You can then enable and disable these services for individual environments of your app. | |||
There was a problem hiding this comment.
Much better. Can we even get rid of the repeated "of the/your app".
|
|
||
| In the **Services** tab, the [Technical Contact](/developerportal/general/app-roles/#technical-contact) can decide which custom services can be used in each environment of this app. | ||
| Note that a service must first be enabled for the app by the [Technical Contact](/developerportal/general/app-roles/#technical-contact) before it can be used. For more information, see [Services](/developerportal/deploy/environments/#services). |
There was a problem hiding this comment.
If a paragraph starts with "Note that" I usually take that as a cue to put it in an Info box. Or find a way or removing the "Note that" at the beginning.
There was a problem hiding this comment.
Rewritten without the "Note that". Also, thanks for sharing that.
This PR has a number of changes but here are some things to look out for:
Available to answer any question that may arise.