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

Commit eb1619c

Browse files
authored
Merge branch 'master' into 2.1.16-release-notes
2 parents cbc8f6e + 22d7667 commit eb1619c

File tree

22 files changed

+899
-651
lines changed

22 files changed

+899
-651
lines changed

_config.checks.yml

+1-5
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,8 @@ html-proofer:
1414
:in_processes: 3
1515
:file_ignore:
1616
- !ruby/regexp /guides\/m1x/
17-
- !ruby/regexp /magento-techbull\.html/
18-
- !ruby/regexp /swagger/
1917
- !ruby/regexp /template\.html/
2018
- !ruby/regexp /videos/
2119
- !ruby/regexp /whats-new\.html/
2220
:url_ignore:
23-
- !ruby/regexp /guides\/v2\.0/
24-
# - !ruby/regexp /mrg/
25-
21+
- !ruby/regexp /guides\/v2\.0/

_config.yml

+92-67
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,22 @@
1-
# Site settings
2-
encoding: "utf-8"
1+
# This file contains configuration settings for the devdocs website.
2+
# Each setting is available on pages using Liquid {{ site.<config key> }}. For example, {{ site.title }}.
3+
# For more details about available options and defaults, refer to https://jekyllrb.com/docs/configuration/
4+
#
35
title: Magento 2 Developer Documentation
46
logo: DevDocs
5-
email: mailto:DL-Magento-Doc-Feedback@magento.com
6-
description: > # this means to ignore newlines until "baseurl:"
7-
Magento 2 Developer Documentation.
8-
baseurl: ""
9-
url: "https://devdocs.magento.com" # the base hostname & protocol for your site
10-
# twitter_username: magento
11-
# github_username: magento
7+
description: Magento 2 Developer Documentation.
8+
9+
# the base protocol and domain
10+
url: https://devdocs.magento.com
11+
12+
# Site theme. https://jekyllrb.com/docs/themes/
1213
theme: devdocs
1314

14-
markdown_ext: "markdown,mkdown,mkdn,mkd,md"
15+
# Base url that forms
16+
baseurl: ""
1517

16-
# Version Switcher. Version numbers should be STRING
18+
# Parameters for the version switcher. Numeric values must be wraped in quotes.
19+
#
1720
version: "2.2"
1821
versions:
1922
-
@@ -29,62 +32,29 @@ versions:
2932
name: "2.3"
3033
url: /guides/v2.3/
3134

32-
# GitHub variables
33-
34-
mage2bloburl: "https://github.com/magento/magento2/blob/"
35-
36-
# 2.0.0 variables
37-
gdeurl: "/guides/v2.0/"
38-
githuburl: "https://github.com/magento/devdocs/tree/develop/guides/v2.0/"
39-
mage2000url: "https://github.com/magento/magento2/blob/2.0/"
40-
41-
# 1.x variables
42-
m1xgdeurl: "/guides/m1x/"
43-
m1xgithuburl: "https://github.com/magento/devdocs/blob/develop/"
44-
45-
# 2.1.0 variables
46-
gdeurl21: "/guides/v2.1/"
47-
githuburl21: "https://github.com/magento/devdocs/tree/develop/guides/v2.1/"
48-
mage2100url: "https://github.com/magento/magento2/blob/2.1/"
49-
50-
# 2.2.0 variables
51-
gdeurl22: "/guides/v2.2/"
52-
githuburl22: "https://github.com/magento/devdocs/tree/develop/guides/v2.2/"
53-
mage2200url: "https://github.com/magento/magento2/blob/2.2/"
54-
55-
# 2.3.0 variables
56-
gdeurl23: "/guides/v2.3/"
57-
githuburl23: "https://github.com/magento/devdocs/tree/develop/guides/v2.3/"
58-
mage2300url: "https://github.com/magento/magento2/blob/2.3-develop/"
59-
60-
# Other variables
61-
namem2fedg: "Magento 2 Frontend Developer's Guide"
62-
namem2devgde: "Magento 2 Developer's Guide"
63-
namem2apiref: "Magento 2 API Reference"
64-
namem2install: "Magento 2 Installation Guide"
65-
66-
6735
collections:
6836
videos:
6937
output: true
7038
permalink: "/videos/:path/"
7139

72-
plugins:
73-
- jekyll-redirect-from
74-
- jekyll-titles-from-headings
75-
40+
# Specific settings for different scopes.
41+
#
7642
defaults:
7743

7844
-
7945
scope:
8046
path: ""
8147
values:
8248
layout: default
83-
github_repo: "https://github.com/magento/devdocs/"
84-
github_files: "https://github.com/magento/devdocs/blob/master/"
49+
github_repo: https://github.com/magento/devdocs/
50+
github_files: https://github.com/magento/devdocs/blob/master/
51+
# Enables the 'Edit this page on GitHub' appearences on pages
52+
github_link: true
53+
# Enables the 'Give us feedback' appearences on pages
54+
feedback_link: true
8555
-
8656
scope:
87-
path: "guides/m1x"
57+
path: guides/m1x
8858
values:
8959
layout: null
9060
-
@@ -95,58 +65,113 @@ defaults:
9565

9666
-
9767
scope:
98-
path: "mftf/2.2"
68+
path: mftf/2.2
9969
values:
10070
group: magento-functional-testing-framework-guide
10171
functional_areas:
10272
- Test
10373

10474
-
10575
scope:
106-
path: "mftf/2.3"
76+
path: mftf/2.3
10777
values:
10878
group: magento-functional-testing-framework-guide-2_3
10979
functional_areas:
11080
- Test
11181

11282
-
11383
scope:
114-
path: "guides/v2.3/mrg"
84+
path: guides/v2.3/mrg
11585
values:
11686
group: module-reference-guide-2_3
11787
github_link: false
11888
feedback_link: false
11989

90+
##########################
91+
# Plugins and extensions #
92+
##########################
93+
#
94+
# For more details about plugins, refer to https://jekyllrb.com/docs/plugins/
95+
# To learn more about particular plugin, find it by name on GitHub.
96+
# This list doesn't include custom plugins.
97+
#
98+
plugins:
99+
- jekyll-redirect-from
100+
- jekyll-titles-from-headings
101+
102+
# Settings for the jekyll-titles-from-headings plugin.
103+
# For more details about the plugin, refer to https://github.com/benbalter/jekyll-titles-from-headings
104+
#
120105
titles_from_headings:
121106
enabled: true
122107
strip_title: true
123108
collections: false
124109

125-
# Build settings
126-
markdown: kramdown
127-
highlighter: rouge
110+
# kramdown parser settings (extended Markdown to HTML parser). For more details about available options, refer to https://kramdown.gettalong.org/converter/html.html
111+
#
128112
kramdown:
129113
toc_levels: 2..3
130114
syntax_highlighter_opts:
131-
css_class: 'highlighter'
132-
133-
incremental: false
115+
css_class: highlighter
134116

117+
# LiveReload monitors changes in the file system and refreshes browser when Jekyll is in serving mode.
118+
# http://livereload.com/
119+
#
135120
livereload: true
136121

122+
# Search engine settings. For more details, refer to https://github.com/algolia/jekyll-algolia
123+
#
137124
algolia:
138-
application_id: 'E642SEDTHL'
139-
index_name: 'devdocs'
140-
api_key: 'd2d0f33ab73e291ef8d88d8b565e754c'
125+
application_id: E642SEDTHL
126+
index_name: devdocs
127+
api_key: d2d0f33ab73e291ef8d88d8b565e754c
141128
files_to_exclude:
142129
- guides/m1x/**/*.html
143130
- guides/m1x/**/*.md
144131
- swagger
145132
- redoc
146133

147134
google:
148-
analytics: 'UA-66243208-1'
135+
analytics: UA-66243208-1
149136

137+
#############
138+
# Variables #
139+
#############
140+
#
141+
# Magento 2 repository variable
142+
mage2bloburl: https://github.com/magento/magento2/blob/
143+
144+
# 2.0 variables
145+
gdeurl: /guides/v2.0/
146+
githuburl: https://github.com/magento/devdocs/tree/master/guides/v2.0/
147+
mage2000url: https://github.com/magento/magento2/blob/2.0/
148+
149+
# 1.x variables
150+
m1xgdeurl: /guides/m1x/
151+
m1xgithuburl: https://github.com/magento/devdocs/blob/master/
152+
153+
# 2.1 variables
154+
gdeurl21: /guides/v2.1/
155+
githuburl21: https://github.com/magento/devdocs/tree/master/guides/v2.1/
156+
mage2100url: https://github.com/magento/magento2/blob/2.1/
157+
158+
# 2.2 variables
159+
gdeurl22: /guides/v2.2/
160+
githuburl22: https://github.com/magento/devdocs/tree/master/guides/v2.2/
161+
mage2200url: https://github.com/magento/magento2/blob/2.2/
162+
163+
# 2.3 variables
164+
gdeurl23: /guides/v2.3/
165+
githuburl23: https://github.com/magento/devdocs/tree/master/guides/v2.3/
166+
mage2300url: https://github.com/magento/magento2/blob/2.3-develop/
167+
168+
169+
##########
170+
# Ignore #
171+
##########
172+
#
173+
# The path patterns excluded during site generation
174+
#
150175
exclude:
151176
- scss
152177
- bin
@@ -162,4 +187,4 @@ exclude:
162187
- Rakefile
163188
- rakelib
164189
- README.md
165-
- _plugins
190+
- _plugins

_data/toc/graphql.yml

+7
Original file line numberDiff line numberDiff line change
@@ -61,12 +61,19 @@ pages:
6161

6262
- label: Other objects
6363
children:
64+
65+
- label: CMS endpoints
66+
url: /graphql/reference/cms.html
67+
6468
- label: CustomAttributeMetadata endpoint
6569
url: /graphql/reference/custom-attribute-metadata.html
6670

6771
- label: Customer endpoint
6872
url: /graphql/reference/customer.html
6973

74+
- label: Quote endpoint
75+
url: /graphql/reference/quote.html
76+
7077
- label: storeConfig endpoint
7178
url: /graphql/reference/store-config.html
7279

common/css/devdocs.css

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

guides/v2.0/config-guide/config/config-create.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ functional_areas:
1414

1515
To extend an existing configuration type, you need only create a configuration file in your {% glossarytooltip c1e4242b-1f1a-44c3-9d72-1d5b1435e142 %}module{% endglossarytooltip %}.
1616

17-
For example, to add an event observer, you create `app/etc/events.xml` and declare a new observer.
17+
For example, to add an event observer, you create `app/code/{VendorName}/{ModuleName}/etc/events.xml` and declare a new observer.
1818

1919
Because the event configuration type already exists in Magento, the loader and the `events.xsd` validating schema are already present and functional.
2020

guides/v2.1/cloud/project/project-upgrade-parent.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,9 @@ Some restrictions in the core {{site.data.var.ee}} code base prevent you from up
2020
| --- | --- |
2121
| 2.1.3 and earlier | You must upgrade to version 2.1.4 or later before you continue. |
2222
| 2.1.4 and later | You can begin the upgrade to [{{site.data.var.ct}} 2002.0.9]({{ page.baseurl }}/cloud/release-notes/cloud-tools.html#v200209) and later. |
23-
| 2.2.x | You can begin the upgrade to [{{site.data.var.ct}} 2002.0.8]({{ page.baseurl }}/cloud/release-notes/cloud-tools.html#v200208) and later. |
23+
| 2.2.x | You can begin the upgrade to [{{site.data.var.ct}} 2002.0.8]({{ page.baseurl }}/cloud/release-notes/cloud-release-archive.html#v200208) and later. |
2424

2525
{: .bs-callout .bs-callout-info}
26-
We combined the upgrade metapackages for tools and patches with the release of [{{site.data.var.ct}} version 2002.0.8](http://devdocs.magento.com/guides/v2.2/cloud/release-notes/cloud-tools.html#v200208) to simplify the process for future updates.
26+
We combined the upgrade metapackages for tools and patches with the release of [{{site.data.var.ct}} version 2002.0.8](http://devdocs.magento.com/guides/v2.2/cloud/release-notes/cloud-release-archive.html#v200208) to simplify the process for future updates.
2727

2828
{% include cloud/note-ece-tools-package.md %}

0 commit comments

Comments
 (0)