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

Commit 930232d

Browse files
authored
Merge pull request magento-commerce/devdocs#2662
Replace absolute links with site variables
2 parents cb68d99 + 5049cf0 commit 930232d

File tree

142 files changed

+334
-337
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

142 files changed

+334
-337
lines changed
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
To help export Production data as test data to use in Staging and Integration environments, [Run the support utilities]({{ site.baseurl }}/guides/v2.3/config-guide/cli/config-cli-subcommands-spt-util.html):
22

33
* [CLI commands]({{ site.baseurl }}/guides/v2.3/config-guide/cli/config-cli-subcommands-spt-util.html#config-cli-spt-utils-db) (Recommended) to export a protected backup of customer and store data using your {{site.data.var.ee}} encryption key
4-
* [Data Collection](http://docs.magento.com/m2/ee/user_guide/system/support-data-collector.html) tool for generating and exporting data
4+
* [Data Collection]({{ site.user_guide_url }}/system/support-data-collector.html) tool for generating and exporting data
55

66
To migrate this data, see [Migrate and deploy static files and data]({{ site.baseurl }}/cloud/live/stage-prod-migrate.html).

src/_includes/cloud/error-codes.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ Critical errors indicate a problem with the {{ site.data.var.ece }} project conf
4646
| 104 | | Failed to parse the `.magento.env.yaml` file | Configuration is not defined in the `./vendor/magento/ece-tools/config/schema.yaml` file. Check that the config variable name is correct, and that it is defined. |
4747
| 105 | | Unable to read the `.magento.env.yaml` file | Unable to read the `./.magento.env.yaml` file. Check file permissions. |
4848
| 106 | | Unable to read the `.schema.yaml` file | |
49-
| 107 | pre-deploy: clean-redis-cache | Failed to clean the Redis cache | Failed to clean the Redis cache. Check that the Redis cache configuration is correct and that the Redis service is available. See [Setup Redis service](https://devdocs.magento.com/cloud/project/services-redis.html). |
49+
| 107 | pre-deploy: clean-redis-cache | Failed to clean the Redis cache | Failed to clean the Redis cache. Check that the Redis cache configuration is correct and that the Redis service is available. See [Setup Redis service]({{ site.baseurl }}/cloud/project/services-redis.html). |
5050
| 108 | pre-deploy: set-production-mode | Command `/bin/magento maintenance:enable` failed | Check the `cloud.log` for more information. For more detailed command output, add the `VERBOSE_COMMANDS: '-vvv'` option to the `.magento.env.yaml` file. |
5151
| 109 | validate-config | Incorrect database configuration | Check that the `DATABASE_CONFIGURATION` environment variable is configured correctly. |
5252
| 110 | validate-config | Incorrect session configuration | Check that the `SESSION_CONFIGURATION` environment variable is configured correctly. The configuration must contain at least the `save` parameter. |
@@ -70,7 +70,7 @@ Critical errors indicate a problem with the {{ site.data.var.ece }} project conf
7070
| 128 | disable-maintenance-mode | Command `/bin/magento maintenance:disable` failed | Check the `cloud.log` for more information. Add `VERBOSE_COMMANDS: '-vvv'` into `.magento.env.yaml` for more detailed command output. |
7171
| 129 | install-update: reset-password | Unable to read reset password template | |
7272
| 130 | install-update: cache_type | Command failed: `php ./bin/magento cache:enable` | Command `php ./bin/magento cache:enable` runs only when Magento was installed but `./app/etc/env.php` file was absent or empty at the beginning of the deployment. Check the `cloud.log` for more information. Add `VERBOSE_COMMANDS: '-vvv'` into `.magento.env.yaml` for more detailed command output. |
73-
| 131 | install-update | The `crypt/key` key value does not exist in the `./app/etc/env.php` file or the `CRYPT_KEY` cloud environment variable | This error occurs if the `./app/etc/env.php` file is not present when Magento deployment begins, or if the `crypt/key` value is undefined. If you migrated the database from another environment, retrieve the crypt key value from that environment. Then, add the value to the [CRYPT_KEY](https://devdocs.magento.com/cloud/env/variables-deploy.html#crypt_key) cloud environment variable in your current environment. See [Add the Magento encryption key](https://devdocs.magento.com/cloud/setup/first-time-setup-import-import.html#encryption-key). If you accidentally removed the `./app/etc/env.php` file, use the following command to restore it from the backup files created from a previous deployment: `./vendor/bin/ece-tools backup:restore` CLI command ." |
73+
| 131 | install-update | The `crypt/key` key value does not exist in the `./app/etc/env.php` file or the `CRYPT_KEY` cloud environment variable | This error occurs if the `./app/etc/env.php` file is not present when Magento deployment begins, or if the `crypt/key` value is undefined. If you migrated the database from another environment, retrieve the crypt key value from that environment. Then, add the value to the [CRYPT_KEY]({{ site.baseurl }}/cloud/env/variables-deploy.html#crypt_key) cloud environment variable in your current environment. See [Add the Magento encryption key]({{ site.baseurl }}/cloud/setup/first-time-setup-import-import.html#encryption-key). If you accidentally removed the `./app/etc/env.php` file, use the following command to restore it from the backup files created from a previous deployment: `./vendor/bin/ece-tools backup:restore` CLI command ." |
7474
| 132 | | Can not connect to the Elasticsearch service | Check for valid Elasticsearch credentials and verify that the service is running |
7575
| 133 | validate-config | Remove Magento Braintree module configuration which is no longer supported in Magento 2.4 and later versions. | Support for the Braintree module is no longer included with Magento 2.4.0 and later. Remove the CONFIG__STORES__DEFAULT__PAYMENT__BRAINTREE__CHANNEL variable from the variables section of the .magento.app.yaml file. For Braintree support, use an official Braintree Payments extension from the Commerce Marketplace instead. |
7676
| 134 | validate-config | Magento 2.4.0 requires Elasticsearch service to be installed | Install Elasticsearch service |

src/_includes/config/es-elasticsearch-magento-24.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
This section discusses the minimum settings you must choose to test Elasticsearch with Magento 2.
2-
For additional details about configuring Elasticsearch, see the [{{site.data.var.ee}} User Guide](http://docs.magento.com/m2/ee/user_guide/catalog/search-elasticsearch.html).
2+
For additional details about configuring Elasticsearch, see the [{{site.data.var.ee}} User Guide]({{ site.user_guide_url }}/catalog/search-elasticsearch.html).
33

44
## Configure Elasticsearch within Magento
55

src/_includes/config/es-elasticsearch-magento.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
This section discusses the minimum settings you must choose to test Elasticsearch with Magento 2.
2-
For additional details about configuring Elasticsearch, see the [{{site.data.var.ee}} User Guide](http://docs.magento.com/m2/ee/user_guide/catalog/search-elasticsearch.html).
2+
For additional details about configuring Elasticsearch, see the [{{site.data.var.ee}} User Guide]({{ site.user_guide_url }}/catalog/search-elasticsearch.html).
33

44
{% include config/es-version-23.md %}
55

src/_includes/layout/header-scripts.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,12 +18,12 @@
1818
label: "Functional areas",
1919
attribute: "functional_areas"
2020
}],
21-
baseUrl: "https://devdocs.magento.com"
21+
baseUrl: "{{ site.baseurl }}"
2222
},
2323
{
2424
label: "User Guide",
2525
name: "merchdocs",
26-
baseUrl: "https://docs.magento.com/user-guide"
26+
baseUrl: "{{ site.user_guide_url }}"
2727
},
2828
{
2929
label: "Commerce Reporting User Guide",

src/cloud/architecture/starter-develop-deploy-workflow.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -97,9 +97,9 @@ Configure your store settings from the Admin panel for the Integration environme
9797
For the best information on configurations, review the documentation for {{site.data.var.ee}} and the installed extensions. Here are some links and ideas to help you get kickstarted:
9898

9999
* [Best practices for store configuration]({{ site.baseurl }}/cloud/configure/configure-best-practices.html) for specific best practices in the cloud
100-
* [Basic configuration](http://docs.magento.com/m2/ee/user_guide/configuration/configuration-basic.html) for store admin access, name, languages, currencies, branding, sites, store views and more
101-
* [Theme](http://docs.magento.com/m2/ee/user_guide/design/design-theme.html) for your look and feel of the site and stores including CSS and layouts
102-
* [System configuration](http://docs.magento.com/m2/ee/user_guide/system/system.html) for roles, tools, notifications, and your encryption key for your database
100+
* [Basic configuration]({{ site.user_guide_url }}/configuration/configuration-basic.html) for store admin access, name, languages, currencies, branding, sites, store views and more
101+
* [Theme]({{ site.user_guide_url }}/design/design-theme.html) for your look and feel of the site and stores including CSS and layouts
102+
* [System configuration]({{ site.user_guide_url }}/system/system.html) for roles, tools, notifications, and your encryption key for your database
103103
* Extension settings using their documentation
104104

105105
Beyond just store settings, you can further configure multiple sites and stores, configured services, and more. See [Configure your store]({{ site.baseurl }}/cloud/configure/configuration-overview.html).

src/cloud/cdn/cloud-vcl-custom-snippets.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ You can create and manage custom VCL snippets from the Admin UI or by using the
4646
- [Admin UI](#manage-custom-vcl-snippets-from-the-magento-admin-ui)—We recommend using the Admin UI to manage custom VCL snippets because it automates the process to validate and upload the custom snippet and apply your changes to the Fastly service configuration. Additionally, you can view and edit the custom VCL snippets added to the Fastly service configuration from the Admin UI.
4747

4848
{:.bs-callout-info}
49-
You must use the Fastly API to [delete custom VCL snippets](https://devdocs.magento.com/cloud/cdn/cloud-vcl-custom-snippets.html#manage-vcl), or you can delete the contents of the snippet in the Admin UI and upload an empty snippet. See [Delete a custom snippet](https://devdocs.magento.com/cloud/cdn/fastly-vcl-badreferer.html#delete-the-custom-vcl-snippet).
49+
You must use the Fastly API to [delete custom VCL snippets]({{ site.baseurl }}/cloud/cdn/cloud-vcl-custom-snippets.html#manage-vcl), or you can delete the contents of the snippet in the Admin UI and upload an empty snippet. See [Delete a custom snippet]({{ site.baseurl }}/cloud/cdn/fastly-vcl-badreferer.html#delete-the-custom-vcl-snippet).
5050

5151
- [Fastly API](#manage-custom-vcl-snippets-using-the-api)—Manage custom VCL snippets using the API if you cannot access the Admin UI. For example, if the site is down and you need to troubleshoot the Fastly service configuration or add a custom VCL snippet. Additionally, some operations can only be completed using the API, for example reactivating an older VCL version or viewing all the VCL snippets included in a specified the VCL version. See [API quick reference for VCL snippets](#manage-vcl).
5252

src/cloud/cdn/configure-fastly.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -217,7 +217,7 @@ To update your DNS configuration for development:
217217
```
218218

219219
{:.bs-callout-info}
220-
As an alternative to using the Magento CLI, you can update the Base URL from the [Admin](https://docs.magento.com/user-guide/stores/store-urls.html#configure-the-base-url).
220+
As an alternative to using the Magento CLI, you can update the Base URL from the [Admin]({{ site.user_guide_url }}/stores/store-urls.html#configure-the-base-url).
221221

222222
1. Restart web browser.
223223

src/cloud/configure/configure-best-practices.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,17 +10,17 @@ functional_areas:
1010
- Configuration
1111
---
1212

13-
For detailed information for configuring your store, sites, and websites, you may want to review the [{{site.data.var.ee}} 2.2.x User Guide](http://docs.magento.com/m2/ee/user_guide/getting-started.html). This page provides best practices, helpful information, and guidelines for configuring your stores, sites, and more with additional content to post over time and across versions.
13+
For detailed information for configuring your store, sites, and websites, you may want to review the [{{site.data.var.ee}} 2.2.x User Guide]({{ site.user_guide_url }}/getting-started.html). This page provides best practices, helpful information, and guidelines for configuring your stores, sites, and more with additional content to post over time and across versions.
1414

1515
## Understanding marketing campaigns and promotions {#campaigns}
1616

1717
This information is helpful for {{site.data.var.ece}} 2.1.X and 2.2.X.
1818

19-
To create campaigns and promotions, you will create the options and settings in [Content Staging](http://docs.magento.com/m2/ee/user_guide/cms/content-staging.html). This feature allows you to create and preview your campaigns prior to making them public for customer sales. The following information provides helpful information. For exact instructions, see the linked {{site.data.var.ee}} User Guide content.
19+
To create campaigns and promotions, you will create the options and settings in [Content Staging]({{ site.user_guide_url }}/cms/content-staging.html). This feature allows you to create and preview your campaigns prior to making them public for customer sales. The following information provides helpful information. For exact instructions, see the linked {{site.data.var.ee}} User Guide content.
2020

2121
_Campaigns_ are marketing events for seasonal sales, new product lines, and more. Each campaign can include custom themes, blocks for content, widgets to control and display content, and associated promotions with price rules. Due to the extensive nature of a campaign, you create them with a start and end date through Content Staging.
2222

23-
_Promotions_ provide discounts, one time offers, coupons, first time buyer incentives, and more. You create these promotions as _Price Rules_ that set the terms, discounts, and options to encourage customers to buy. You can create price rules on the [shopping cart](http://docs.magento.com/m2/ee/user_guide/marketing/price-rules-cart.html) or [catalog](http://docs.magento.com/m2/ee/user_guide/marketing/price-rules-catalog.html), with additional options for banners, reward points, and more. We also support scheduling campaigns for your promotions, applying price rules for major events like a new product line or seasonal sales.
23+
_Promotions_ provide discounts, one time offers, coupons, first time buyer incentives, and more. You create these promotions as _Price Rules_ that set the terms, discounts, and options to encourage customers to buy. You can create price rules on the [shopping cart]({{ site.user_guide_url }}/marketing/price-rules-cart.html) or [catalog]({{ site.user_guide_url }}/marketing/price-rules-catalog.html), with additional options for banners, reward points, and more. We also support scheduling campaigns for your promotions, applying price rules for major events like a new product line or seasonal sales.
2424

2525
The following are tips to help create, update, and manage promotions and campaigns:
2626

@@ -33,7 +33,7 @@ The following are tips to help create, update, and manage promotions and campaig
3333

3434
This information is helpful for {{site.data.var.ece}} 2.1.X and 2.2.X.
3535

36-
Typically, you can set [Advanced Pricing](http://docs.magento.com/m2/ee/user_guide/catalog/pricing-advanced.html) for products through the **Products** > **Catalogs** area of the Admin. With Staged Content, you need to complete a few extra steps to add the pricing to a promotion and campaign.
36+
Typically, you can set [Advanced Pricing]({{ site.user_guide_url }}/catalog/pricing-advanced.html) for products through the **Products** > **Catalogs** area of the Admin. With Staged Content, you need to complete a few extra steps to add the pricing to a promotion and campaign.
3737

3838
To edit Advanced Pricing and update Content Staging:
3939

@@ -46,7 +46,7 @@ To edit Advanced Pricing and update Content Staging:
4646
1. Save the promotion. An inactive initial campaign is created.
4747
1. You can Preview to review the special price, promotion name, regular price, and the scheduled date range for the campaign.
4848

49-
For additional steps, you can continue with instructions with [Schedule Changes for Catalog Price Rules](http://docs.magento.com/m2/ee/user_guide/marketing/price-rule-catalog-scheduled-changes.html). Click **Next** to walk through the steps.
49+
For additional steps, you can continue with instructions with [Schedule Changes for Catalog Price Rules]({{ site.user_guide_url }}/marketing/price-rule-catalog-scheduled-changes.html). Click **Next** to walk through the steps.
5050

5151
## Example Price Rules {#price-rules}
5252

@@ -56,7 +56,7 @@ To create a Price Rule, see our [{{site.data.var.ee}} User Guide](https://docs.m
5656

5757
The following provides an example of creating a Price Rule for a First Order Only discount. For this discount, you would want to:
5858

59-
* Create a price rule with a [customer segment](http://docs.magento.com/m2/ee/user_guide/marketing/customer-segment-price-rule.html) with a condition: Total Number of Orders less than 1
59+
* Create a price rule with a [customer segment]({{ site.user_guide_url }}/marketing/customer-segment-price-rule.html) with a condition: Total Number of Orders less than 1
6060
* Add this customer segment as a condition to the cart rule
6161
* Optional - Add conditions and rules to apply the discounts to specific SKUs or categories of products for focused purchases
6262

src/cloud/configure/setup-b2b.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ To extend functionality, see the [{{site.data.var.ee}} B2B Developer Guide][b2b-
8585

8686
[admin-enable]: {{ site.baseurl }}/extensions/b2b/#enable-b2b-features-in-magento-admin
8787
[b2b-dev]: {{ site.baseurl }}/guides/v2.3/b2b/bk-b2b.html
88-
[b2b-user]: http://docs.magento.com/m2/b2b/user_guide/getting-started.html
88+
[b2b-user]: {{ site.user_guide_url }}/getting-started.html
8989
[branching]: {{ site.baseurl }}/cloud/env/environments-start.html#getstarted
9090
[config]: {{ site.baseurl }}/guides/v2.3/config-guide/config/config-php.html
9191
[extensions]: {{ site.baseurl }}/extensions/

0 commit comments

Comments
 (0)