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

Commit a9504d1

Browse files
authored
Merge branch 'master' into patch-27
2 parents 35a480e + 7240632 commit a9504d1

File tree

108 files changed

+2280
-918
lines changed

Some content is hidden

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

108 files changed

+2280
-918
lines changed

.gitignore

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,14 @@
1919
!/_config.stage.yml
2020

2121
*.bat
22-
*.sh
2322
/tmp/
24-
!/**/samples/*.sh
2523
/vendor/
2624
/node_modules/
2725

2826
_algolia_api_key
27+
28+
# Docs from different repositories #
29+
###################################
30+
31+
/mbi/
32+
/page-builder/

Gemfile.lock

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
GIT
22
remote: https://github.com/magento-devdocs/devdocs-theme.git
3-
revision: 1ce56765123d6c552ae1c251a0df924971269f89
3+
revision: dcb189be6fd4e0ebc69dce7cd6cdeb3b960b3a9e
44
specs:
55
devdocs (0.0.1)
66
jekyll (~> 3.3)

Rakefile

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,9 @@ require 'launchy'
1212
require 'colorator'
1313

1414
# Load ruby files with helper methods from the 'rakelib/' directory
15-
require_relative 'rakelib/link-checker.rb'
16-
require_relative 'rakelib/converter.rb'
17-
require_relative 'rakelib/double-slash-check.rb'
15+
require_relative 'rakelib/lib/link-checker.rb'
16+
require_relative 'rakelib/lib/converter.rb'
17+
require_relative 'rakelib/lib/double-slash-check.rb'
1818

1919
desc "Same as 'rake', 'rake preview'"
2020
task default: %w[preview]
@@ -56,3 +56,6 @@ task build: %w[clean] do
5656
sh 'bundle exec jekyll build --verbose --trace'
5757
puts 'Built!'.green
5858
end
59+
60+
desc 'Pull docs from external repositories'
61+
task init: %w[multirepo:init]

_config.yml

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,14 @@ defaults:
6464
values:
6565
layout: video
6666

67+
-
68+
scope:
69+
path: mbi
70+
values:
71+
group: mbi
72+
github_files: https://github.com/magento/devdocs-mbi/blob/master/
73+
github_repo: https://github.com/magento/devdocs-mbi/
74+
6775
-
6876
scope:
6977
path: mftf/2.2
@@ -84,9 +92,7 @@ defaults:
8492
scope:
8593
path: page-builder
8694
values:
87-
layout: default
8895
group: page-builder
89-
strip_title: true
9096
github_link: false
9197
feedback_link: false
9298

@@ -178,6 +184,10 @@ algolia:
178184
- guides/m1x/**/*.md
179185
- swagger
180186
- redoc
187+
# Index HTML elements, especially code samples.
188+
nodes_to_index: 'p,li,td,code'
189+
# Override 10KB default and use our allowed max of 20KB
190+
max_record_size: 20000
181191

182192
google:
183193
analytics: UA-66243208-1

_data/main-nav.yml

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@
100100
- label: Admin Style Guide
101101
url: /design-styleguide/bk-styleguide.html
102102

103-
- label: Magento PWA Documentation Site
103+
- label: PWA Documentation Site
104104
url: https://magento-research.github.io/pwa-studio/
105105
include_versions: ['2.3']
106106

@@ -124,9 +124,11 @@
124124
url: /marketplace/eqp/api.html
125125
exclude_versions: ['2.0']
126126

127-
- label: Magento BI Import REST API
128-
url: https://developers.rjmetrics.com/
127+
- label: Business Intelligence Import API
128+
url: /mbi/docs/getting-started.html
129129
exclude_versions: ['2.0']
130+
versionless: true
131+
130132

131133
- label: Testing
132134
children:

_data/toc/cloud-guide.yml

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,9 @@ pages:
7272
- label: Launch Docker
7373
url: /cloud/docker/docker-config.html
7474

75+
- label: Configure Xdebug for Docker
76+
url: /cloud/docker/docker-development-debug.html
77+
7578
- label: Docker quick reference
7679
url: /cloud/docker/docker-quick-reference.html
7780

@@ -172,22 +175,22 @@ pages:
172175
url: /cloud/cdn/fastly-image-optimization.html
173176
exclude_versions: ["2.0"]
174177

175-
- label: Custom Fastly VCL snippets
178+
- label: Custom VCL snippets
176179
url: /cloud/cdn/cloud-vcl-custom-snippets.html
177180
exclude_versions: ["2.0"]
178181
children:
179-
- label: Custom whitelist VCL
182+
- label: Set up redirects to WordPress
183+
url: /cloud/cdn/fastly-vcl-wordpress.html
184+
185+
- label: Block referral spam
186+
url: /cloud/cdn/fastly-vcl-badreferer.html
187+
188+
- label: Secure access to the Magento Admin UI
180189
url: /cloud/cdn/fastly-vcl-whitelist.html
181190

182191
- label: Custom blacklist VCL
183192
url: /cloud/cdn/fastly-vcl-blacklist.html
184193

185-
- label: Custom redirect to WordPress VCL
186-
url: /cloud/cdn/fastly-vcl-wordpress.html
187-
188-
- label: Custom block bad referer VCL
189-
url: /cloud/cdn/fastly-vcl-badreferer.html
190-
191194
- label: Fastly troubleshooting
192195
url: /cloud/cdn/trouble-fastly.html
193196

_data/toc/graphql.yml

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,3 @@ pages:
7979

8080
- label: urlResolver endpoint
8181
url: /graphql/reference/url-resolver.html
82-
83-
- label: Wishlist endpoint
84-
url: /graphql/reference/wishlist.html

_data/toc/magento-functional-testing-framework-guide-2_3.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -113,6 +113,10 @@ pages:
113113
url: /mftf/2.3/troubleshooting.html
114114
versionless: true
115115

116+
- label: Versioning
117+
url: /mftf/2.3/versioning.html
118+
versionless: true
119+
116120
- label: Contribution guidelines
117121
url: https://github.com/magento/magento2-functional-testing-framework/blob/master/.github/CONTRIBUTING.md
118122
versionless: true

_data/toc/mbi.yml

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
label: Business Intelligence
2+
url: /mbi/docs/
3+
versionless: true
4+
pages:
5+
- label: Getting started
6+
url: /mbi/docs/getting-started.html
7+
versionless: true
8+
9+
- label: Import API
10+
url: /mbi/docs/import-api.html
11+
versionless: true
12+
13+
- label: Cloud onboarding API
14+
url: /mbi/docs/cloud-api.html
15+
versionless: true
16+
17+
- label: Libraries
18+
url: /mbi/docs/libraries.html
19+
versionless: true

_data/whats-new.yml

Lines changed: 110 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,117 @@ description: |
44
We exclude from this list proofreading, spelling checks, and all minor updates.
55
link: /whats-new.html
66
thread: /whatsnew-feed.xml
7-
updated: Tue Feb 19 10:45:50 2019
7+
updated: Mon Mar 4 13:13:10 2019
88
entries:
9+
- description: Added a section about [Required System Dependencies](http://devdocs.magento.com/guides/v2.3/install-gde/system-requirements-tech.html#required-system-dependencies)<br/>Added
10+
a section about [Unsupported Operating Systems](http://devdocs.magento.com/guides/v2.3/install-gde/system-requirements-tech.html#unsupported-operating-systems)
11+
versions: 2.3.x
12+
type: Major update
13+
date: March 4, 2019
14+
link: https://github.com/magento/devdocs/pull/3864
15+
- description: Update [community contribution guidelines](https://devdocs.magento.com/guides/v2.3/contributor-guide/contributing.html#porting)
16+
about porting
17+
versions: 2.x
18+
type: Major update
19+
date: March 4, 2019
20+
link: https://github.com/magento/devdocs/pull/3850
21+
- description: Fixed the incorrect `composer install` command in [Set up an Embedded
22+
MFTF](https://devdocs.magento.com/mftf/2.3/getting-started.html#setup-framework).
23+
versions: 2.3.x
24+
type: Technical changes
25+
date: March 4, 2019
26+
link: https://github.com/magento/devdocs/pull/3863
27+
- description: Migrated the Magento Business Intelligence (MBI) [Import API documentation](https://devdocs.magento.com/mbi/docs/getting-started.html)
28+
from the RJMetrics domain to the Magento domain.
29+
versions: '2.x'
30+
type: Major update
31+
date: March 1, 2019
32+
link: https://github.com/magento/devdocs/pull/3841
33+
- description: "- Updated the [Custom VCL snippets](https://devdocs.magento.com/guides/v2.3/cloud/cdn/cloud-vcl-custom-snippets.html)
34+
with instructions for using the Magento Admin UI to create and manage VCL snippets.<br/>-
35+
\ Updated and corrected the following examples for using Fastly Edge Dictionaries
36+
and custom VCL snippets to manage request routing for Magento Commerce Cloud traffic:
37+
[Set up redirects to WordPress backend](https://devdocs.magento.com/guides/v2.3/cloud/cdn/fastly-vcl-wordpress.html),
38+
[Block referrer spam](https://devdocs.magento.com/guides/v2.3/cloud/cdn/fastly-vcl-badreferer.html),
39+
and [Secure access to the Admin UI by client IP address](https://devdocs.magento.com/guides/v2.3/cloud/cdn/fastly-vcl-whitelist.html).
40+
Included prerequisites and instructions for adding VCL snippets from the Admin
41+
UI or Fastly API."
42+
versions: 2.1.x, 2.2.x, 2.3.x
43+
type: Technical changes
44+
date: March 1, 2019
45+
link: https://github.com/magento/devdocs/pull/3623
46+
- description: Updated the [GitHub integration topic](https://devdocs.magento.com/guides/v2.2/cloud/integrations/github-integration.html).
47+
versions: 2.x
48+
type: Technical changes
49+
date: March 1, 2019
50+
link: https://github.com/magento/devdocs/pull/3843
51+
- description: Updated example for requesting domain delegation when configuring Fastly
52+
services for a Magento Commerce Cloud project. See [Multiple Fastly accounts and
53+
assigned domains](https://devdocs.magento.com/guides/v2.3/cloud/cdn/configure-fastly.html#domain).
54+
versions: 2.1.x, 2.2.x, 2.3.x
55+
type: Technical changes
56+
date: February 28, 2019
57+
link: https://github.com/magento/devdocs/pull/3814
58+
- description: Update Commerce, PWA, and Page Builder [product availability](https://devdocs.magento.com/availability)
59+
versions: 2.3.x
60+
type: Major update
61+
date: February 28, 2019
62+
link: https://github.com/magento/devdocs/pull/3833
63+
- description: 'Updated the [Cloud Release notes for ece-tools version 2002.0.16.](http://devdocs.magento.com/guides/v2.3/cloud/release-notes/cloud-tools.html#v2002016)<br/>-
64+
Updated the Cloud Docker content with information about using the [`sendmail`
65+
service](http://devdocs.magento.com/cloud/docker/docker-development.html#sendmail-service).<br/>- Updated
66+
the Cloud Docker content to explain how to [configure Xdebug](http://devdocs.magento.com/guides/v2.3/cloud/docker/docker-development-debug.html).<br/>-
67+
Added two new environment variables: [RESOURCE_CONFIGURATION deploy variable](http://devdocs.magento.com/guides/v2.3/cloud/env/variables-deploy.html)
68+
and [X_FRAME_CONFIGURATION global variable](http://devdocs.magento.com/guides/v2.3/cloud/env/variables-global.html)<br/>-
69+
Updated the [ADMIN variables](https://devdocs.magento.com/guides/v2.3/cloud/env/environment-vars_magento.html)
70+
and clarified the usage of ADMIN variables in the [Access your Magento Admin panel](https://devdocs.magento.com/guides/v2.3/cloud/onboarding/onboarding-tasks.html)
71+
page.<br/>- Added an example for preloading pages from multiple domains in the
72+
[WARM_UP_PAGES post-deploy variable](https://devdocs.magento.com/guides/v2.3/cloud/env/variables-post-deploy.html#warm_up_page).<br/>-
73+
Deprecated SCD_EXCLUDE_THEMES environment variable.<br/>- Clarified the [backup
74+
and retention](https://devdocs.magento.com/guides/v2.3/cloud/architecture/pro-architecture.html#backup-and-disaster-recovery)
75+
statements regarding the most recent 24-hour period.'
76+
versions: 2.1.x, 2.2.x, 2.3.x
77+
type: Major update
78+
date: February 26, 2019
79+
link: https://github.com/magento/devdocs/pull/3788
80+
- description: Updated data types for Inventory Management [Check salable quantities](https://devdocs.magento.com/guides/v2.3/rest/modules/inventory/check-salable-quantity.html),
81+
[Manage low-quantity notifications](https://devdocs.magento.com/guides/v2.3/rest/modules/inventory/manage-low-quantity.html),
82+
[Manage source items](https://devdocs.magento.com/guides/v2.3/rest/modules/inventory/manage-source-items.html),
83+
and [Manage source selection algorithms](https://devdocs.magento.com/guides/v2.3/rest/modules/inventory/manage-source-selection.html)
84+
versions: 2.3.x
85+
type: Technical changes
86+
date: February 26, 2019
87+
link: https://github.com/magento/devdocs/pull/3804
88+
- description: Removed improper git commands for composer reinstall in [Uninstall
89+
and Reinstall Magento](https://devdocs.magento.com/guides/v2.3/install-gde/install/cli/install-cli-uninstall.html#instgde-install-magento-reinstall)
90+
and links to correct instructions.
91+
versions: 2.2.x, 2.3.x
92+
type: Technical changes
93+
date: February 22, 2019
94+
link: https://github.com/magento/devdocs/pull/3802
95+
- description: Added the section [Merge action groups](http://devdocs.magento.com/mftf/2.3/merging.html#merge-action-groups)
96+
to the Merging page in the MFTF guide.
97+
versions: 2.3.x
98+
type: Major update
99+
date: February 21, 2019
100+
link: https://github.com/magento/devdocs/pull/3792
101+
- description: Added the missing `cache` command in [Disable Module Output](https://devdocs.magento.com/guides/v2.2/config-guide/config/disable-module-output.html#export-the-configuration-changes).
102+
versions: 2.2.x, 2.3.x
103+
type: Technical changes
104+
date: February 21, 2019
105+
link: https://github.com/magento/devdocs/pull/3799
106+
- description: Added a [Versioning](https://devdocs.magento.com/mftf/2.3/versioning.html)
107+
topic to the MFTF guide.
108+
versions: 2.2.x, 2.3.x
109+
type: Major update
110+
date: February 21, 2019
111+
link: https://github.com/magento/devdocs/pull/3781
112+
- description: Added information about testing strategies to the [Magento Testing
113+
Guide](https://devdocs.magento.com/guides/v2.3/test/testing.html).
114+
versions: 2.2.x, 2.3.x
115+
type: Major update
116+
date: February 20, 2019
117+
link: https://github.com/magento/devdocs/pull/3791
9118
- description: Added [Use parameterized selectors in action groups with argument references](https://devdocs.magento.com/mftf/2.3/tips-tricks.html#use-parameterized-selectors-in-action-groups-with-argument-references)
10119
to Tips and Tricks.
11120
versions: 2.3.x
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
1. [Log in]({{ page.baseurl }}/cloud/onboarding/onboarding-tasks.html#admin) to the Magento Admin UI.
Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
## Modify the custom VCL snippet
2+
3+
1. [Log in]({{ page.baseurl }}/cloud/onboarding/onboarding-tasks.html#admin) to the Magento Admin UI.
4+
5+
1. Click **Stores** > **Settings** > **Configuration** > **Advanced** > **System**.
6+
7+
1. Expand **Full Page Cache** > **Fastly Configuration** > **Custom VCL Snippets**.
8+
9+
![Manage custom VCL snippets]
10+
11+
1. In the _Action_ column, click the settings icon next to the snippet to edit.
12+
13+
1. After the page reloads, click **Upload VCL to Fastly** in the *Fastly Configuration* section.
14+
15+
1. After the upload completes, refresh the cache according to the notification at the top of the page.
16+
17+
18+
{: .bs-callout .bs-callout-warning}
19+
The *Custom VCL snippets* UI option shows only the snippets added through the Admin UI. You must use the Fastly API to [manage custom snippets added through the API]({{ page.baseurl }}/cloud/cdn/cloud-vcl-custom-snippets.html#manage-custom-vcl-snippets-using-the-api).
20+
21+
22+
## Delete the custom VCL snippet
23+
24+
You can delete custom VCL snippet code from your Fastly configuration by uploading an empty version of the snippet from the Magento Admin UI, or delete it completely using the Fastly API.
25+
26+
- Upload an empty version of the snippet file to Fastly to remove the VCL logic from the active VCL version:
27+
28+
- Edit the snippet and delete the **VCL** snippet content.
29+
30+
- Save the configuration.
31+
32+
- Upload the VCL to Fastly to apply your changes.
33+
34+
- Use the Fastly API [Delete custom VCL snippet]({{ page.baseurl }}/cloud/cdn/cloud-vcl-custom-snippets.html#manage-vcl) operation
35+
to delete the snippet completely, or submit a Magento support ticket to request deletion.
36+
37+
38+
[Manage custom VCL snippets]: {{site.baseurl}}/common/images/cloud/cloud-fastly-manage-snippets.png
39+
{: width="650px"}

_includes/layout/footer-scripts.html

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,3 @@
2828
<script type="text/javascript">_satellite.pageBottom();</script>
2929

3030
{% endif %}
31-
32-
33-
{% if page.url contains "cloud/" %}
34-
<script type="text/javascript" src="{{ site.baseurl }}/common/js/survey.js"></script>
35-
{% endif %}

_includes/layout/page-info.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313

1414
{% if page.github_link %}
1515
<div class="github-link">
16-
<a class="improve-page" href="{{ page.github_files }}{{ page.path }}" target="_blank" rel="noopener">
16+
<a class="improve-page" href="{{ page.github_files }}{{ page.github_path }}" target="_blank" rel="noopener">
1717
Edit this page on GitHub
1818
</a>
1919
</div>

_plugins/algolia.rb

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
module Jekyll
2+
module Algolia
3+
module Hooks
4+
def self.before_indexing_each(record, node, context)
5+
# Do not index records larger than 20000 bytes
6+
return nil if record.to_s.bytesize > 20000
7+
8+
record
9+
end
10+
end
11+
end
12+
end

0 commit comments

Comments
 (0)