Skip to content
This repository was archived by the owner on Nov 19, 2024. It is now read-only.

Commit d579f75

Browse files
maeker12maeker12
authored andcommitted
- Editorial clean up
- Correct instructions for configuring project and environment variables
1 parent 87362f1 commit d579f75

File tree

2 files changed

+36
-32
lines changed

2 files changed

+36
-32
lines changed

src/cloud/project/project-webint-basic.md

Lines changed: 36 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -61,30 +61,30 @@ You can set the following configuration options for each environment:
6161
</tr>
6262
<tr>
6363
<td>HTTP access control</td>
64-
<td>Setting this option <strong>On</strong> enables you to configure security for the project's Web Interface using a login and also IP address access control.</td>
64+
<td>Setting this option <strong>On</strong> enables you to configure security for the Project Web Interface using a login and also IP address access control.</td>
6565
</tr>
6666
</table>
6767

6868
### Configure emails for testing {#email}
6969

7070
By default, email support is **disabled** on Staging and Production environments. You must enable email support on an environment to send emails including Welcome, password reset, and two-factor authentication emails for Cloud project users.
7171

72-
You can manage email support for each Cloud project environment from the Project Web interface or from the command line.
72+
You can manage email support for each Cloud project environment from the Project Web Interface or from the command line.
7373

7474
- On master and integration branches, use the *Outgoing emails* toggle in the Project Web interface to enable or disable email support.
7575

76-
- On Production and Staging environments or other environments where the *Outgoing emails toggle* is not available in the Project Web interface, you can check the current configuration from the Project Web interface, but you can only change the configuration from the command line using the [Cloud CLI for Commerce]({{ site.baseurl }}/cloud/reference/cli-ref-topic.html) `environment:info` command to set the `enable_smtp` property.
76+
- On Production and Staging environments or other environments where the *Outgoing emails toggle* is not available in the Project Web Interface, you can check the current configuration from the Project Web Interface, but you can only change the configuration from the command line using the [Cloud CLI for Commerce]({{ site.baseurl }}/cloud/reference/cli-ref-topic.html) `environment:info` command to set the `enable_smtp` property.
7777

7878
Enabling SMTP updates the `MAGENTO_CLOUD_SMTP_HOST` environment variable with the IP address of the SMTP host for sending mail.
7979

8080
{% include cloud/note-env-config-redeploy-warning.md%}
8181

8282
{:.procedure}
83-
To manage email support from the Project Web interface:
83+
To manage email support from the Project Web Interface:
8484

8585
1. [Access your project](#project-access) and select the environment to configure.
8686

87-
1. Select **Configure environment**.
87+
1. Select **Configure environment**, and then select the **Variables** tab.
8888

8989
1. To enable or disable outgoing emails, toggle *Outgoing emails* **On** or **Off**.
9090

@@ -95,7 +95,7 @@ After you change the setting, the environment builds and deploys with the new co
9595
{:.procedure}
9696
To manage email support from the command line:
9797

98-
1. Check the current email configuration in the Project web interface.
98+
1. Check the current email configuration in the Project Web Interface.
9999

100100
![Check outgoing email configuration]({{ site.baseurl }}/common/images/cloud/cloud-env-outgoing-emails-current-setting.png){:width="650px"}
101101

@@ -136,62 +136,66 @@ To manage email support from the command line:
136136
```bash
137137
printenv MAGENTO_CLOUD_SMTP_HOST
138138
```
139+
139140
- Send a test email to your email address or another address you can check.
140141

141142
```bash
142143
php -r 'mail("mail@example.com", "test message", "just testing", "From: tester@example.com");'
143144
```
144145

145-
## Set environment and project variables {#project-conf-env-var}
146+
## Set project and environment variables {#project-conf-env-var}
146147

147-
You can set project wide and environment specific variables through the Project Web Interface. Variables can be either text or JSON format. For more information, see [Environment variables]({{ site.baseurl }}/cloud/env/variables-intro.html).
148-
149-
For an example of variables, we walk you through creating Admin variables through Onboarding and project creation tasks. You may want to add _environment variables_ for sensitive data like payment method information. _Project variables_ are set across all branches and environments.
148+
You can set project wide and environment specific variables through the Project Web Interface. Variables can be either text or JSON format. _Project variables_ are set across all branches and environments. Use _environment variables_ for sensitive data like payment method information. For more information, see [Environment variables]({{ site.baseurl }}/cloud/env/variables-intro.html).
150149

151150
To view or edit environment variables, you must have at minimum the project reader role with [environment admin]({{ site.baseurl }}/cloud/project/user-admin.html) privileges.
152151

153152
{% include cloud/wings-variables.md %}
154153

155-
### Environment variable {#env}
154+
### Project variables {#project}
156155

157-
To set environment specific variables in the Project Web Interface:
156+
To set project variables in the Project Web Interface:
157+
158+
1. [Access your project](#project-access).
159+
1. Select the Settings icon, and then select the **Variables** tab.
160+
161+
![Configure project variables]({{ site.baseurl }}/common/images/cloud/cloud-config-project-variables.png){:width="650px"}
158162

159-
1. [Access your project](#project-access) and select a specific environment.
160-
1. Select the Variables tab.
161163
1. Click **Add Variable**.
162-
1. In the **Name** field, enter a variable name. For example, to set the Admin default account password, enter `ADMIN_PASSWORD`.
164+
1. In the **Name** field, enter a variable name. For example, to set the Admin email for the default account, enter `ADMIN_EMAIL`.
163165
1. In the **Value** field, enter the value for the variable. For example, enter a valid email address accessible for reset email notifications.
164166

165-
![Set environment variables]({{ site.baseurl }}/common/images/cloud/cloud_env-var.png)
167+
![Set project variables]({{ site.baseurl }}/common/images/cloud/cloud_project_variable.png)
166168

167-
1. As needed, select options for **JSON value**, **Enabled**, **Inheritable by child environments** and **Sensitive**. If you do not have Super User access, you may only see the JSON value option.
169+
1. As needed, select options for **JSON value**, **Visible during build**, and **Visible during runtime**. If you do not have Super User access, you may only see the JSON value option.
168170
1. Click **Add Variable**. After you add the variable, the environment will deploy. Wait until deployment completes before more edits.
169171

170-
{:.bs-callout-warning}
171-
If you are attempting to [override configuration settings]({{ site.baseurl }}
172-
), you must prepend `env:` to the variable name. For example:
173-
![Environment variable example]({{ site.baseurl }}/common/images/cloud/cloud_env_var_example.png)
174-
175-
### Project variable {#project}
172+
### Environment variables {#env}
176173

177-
To set project variables in the Project Web Interface:
174+
To set environment specific variables in the Project Web Interface:
178175

179176
1. [Access your project](#project-access) and select a specific environment.
180-
1. Select the Variables tab.
177+
1. Select **Configure environment**.
178+
1. Select the **Variables** tab.
181179
1. Click **Add Variable**.
182-
1. In the **Name** field, enter a variable name. For example, to set the Admin email for the default account, enter `ADMIN_EMAIL`.
180+
1. In the **Name** field, enter a variable name. For example, to set the Admin default account password, enter `ADMIN_PASSWORD`.
183181
1. In the **Value** field, enter the value for the variable. For example, enter a valid email address accessible for reset email notifications.
184182

185-
![Set project variables]({{ site.baseurl }}/common/images/cloud/cloud_project_variable.png)
183+
![Set environment variables]({{ site.baseurl }}/common/images/cloud/cloud_env-var.png){:width="650px"}
186184

187-
1. As needed, select options for **JSON value**, **Visible during build**, and **Visible during runtime**. If you do not have Super User access, you may only see the JSON value option.
185+
1. As needed, select options for **JSON value**, **Enabled**, **Inheritable by child environments** and **Sensitive**. If you do not have Super User access, you may only see the JSON value option.
188186
1. Click **Add Variable**. After you add the variable, the environment will deploy. Wait until deployment completes before more edits.
189187

188+
{:.bs-callout-warning}
189+
If you are attempting to [override configuration settings]({{ site.baseurl }}
190+
), you must prepend `env:` to the variable name. For example:
191+
![Environment variable example]({{ site.baseurl }}/common/images/cloud/cloud_env_var_example.png)
192+
190193
## Configure routes {#project-conf-env-route}
191194

192195
Routes allow you to set redirects or upstream settings for applications for your specific environment. For full details on routes, see [routes.yaml]({{ site.baseurl }}/cloud/project/routes.html). These routes (or URLs) are used to access your storefront.
193196

194197
1. [Access your project](#project-access) and select a specific environment.
198+
1. Select **Configure environment**.
195199
1. Select the Routes tab.
196200
1. Select **Add Route**.
197201
1. Enter a URL. You can use `{default}` in the URL, which is a placeholder for the default domain.
@@ -207,7 +211,7 @@ Routes allow you to set redirects or upstream settings for applications for your
207211
1. To configure a Redirect, enter a URL to **Redirect to**. You can use `{default}` in the URL, which is a placeholder for the default domain.
208212
1. Click **Add Route** to save. The setting is saved and deployed to the environment.
209213

210-
![Configure a route]({{ site.baseurl }}/common/images/cloud/cloud_routes.png)
214+
![Configure a route]({{ site.baseurl }}/common/images/cloud/cloud_routes.png){:width="650px"}
211215

212216
## View environment history {#project-conf-hist}
213217

@@ -218,19 +222,19 @@ An environment's history includes:
218222
- Syncs and merges
219223
- Code pushes
220224
221-
To view the history for an environment, log in to your project and select the environment. The page displays a general history of actions completed on the page. For a detailed list of completed actions during build and deployment, we recommend reviewing logs directly on the servers. See [View logs]({{ site.baseurl }}/cloud/project/log-locations.html).
225+
To view the history for an environment, log in to your project and select the environment. The page displays a general history of actions completed on the page. For a detailed list of completed actions during build and deployment, Adobe recommends reviewing logs directly on the servers. See [View logs]({{ site.baseurl }}/cloud/project/log-locations.html).
222226
223227
The following figure shows a sample history.
224228
225-
![Sample environment history]({{ site.baseurl }}/common/images/cloud/cloud_environment-history.png)
229+
![Sample environment history]({{ site.baseurl }}/common/images/cloud/cloud_environment-history.png){:width="800px"}
226230
227231
The history shows, from oldest to newest:
228232
229233
- Environment branched from `FeatureX`
230234
- Environment synced with the parent
231235
- Environment snapshot created
232236
233-
We recommend [creating a snapshot]({{ site.baseurl }}/cloud/project/project-webint-snap.html) before you make any code changes.
237+
Adobe recommends [creating a snapshot]({{ site.baseurl }}/cloud/project/project-webint-snap.html) before you make any code changes.
234238
235239
- Environment variable added
236240
- Environment snapshot created
Loading

0 commit comments

Comments
 (0)