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

Commit 243a92f

Browse files
author
Vasilii Burlacu
committed
Merge remote-tracking branch 'upstream/master' into addition/widget-dropdown
# Conflicts: # guides/v2.1/javascript-dev-guide/widgets/jquery-widgets-about.md
2 parents ce27fda + 7419370 commit 243a92f

File tree

3,560 files changed

+264461
-191955
lines changed

Some content is hidden

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

3,560 files changed

+264461
-191955
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
<!-- # IMPORTANT
2+
3+
We are no longer accepting pull requests to update v2.1 devdoc files.
4+
5+
Magento 2.1.18 is the final 2.1.x release. After the [June 2019 end-of-support date](https://magento.com/sites/default/files/magento-software-lifecycle-policy.pdf), Magento will no longer apply security patches, quality fixes, or documentation updates to v2.1.x. To maintain your site's performance, security, and PCI compliance, [upgrade](https://devdocs.magento.com/guides/v2.3/comp-mgr/bk-compman-upgrade-guide.html) to the latest version of Magento. -->
6+
17
## Purpose of this pull request
28

39
<!-- REQUIRED Describe the goal and the type of changes this pull request covers. -->
@@ -8,14 +14,12 @@ This pull request (PR) ...
814

915
<!-- REQUIRED List the affected pages on devdocs.magento.com (URLs). Not needed for large numbers of files. -->
1016

11-
- ...
1217
- ...
1318

1419
## Links to Magento source code
1520

1621
<!-- OPTIONAL - REMOVE THIS SECTION IF NOT USED. If this pull request references a file in a Magento codebase repository, add it here. -->
1722

18-
- ...
1923
- ...
2024

2125
<!--

.gitignore

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
######################
33
/*.db
44
.DS_Store
5+
.vscode
56

67
# Config and output files #
78
###########################
@@ -10,6 +11,7 @@
1011

1112
_config.local.yml
1213
.jekyll-metadata
14+
.whatsup.yml
1315

1416
*.bat
1517
/tmp/
@@ -30,4 +32,5 @@ _algolia_api_key
3032
# Docs from different branches #
3133
###################################
3234

33-
/guides/v2.0/
35+
/guides/v2.0/
36+
/guides/v2.1/

Docfile.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
content_map:
22
-
3-
directory: guides/v2.0
3+
directory: guides/v2.1
44
repository: magento/devdocs
5-
branch: 2.0
5+
branch: 2.1
66
filter: false
77
-
88
directory: guides/m1x
@@ -17,7 +17,7 @@ content_map:
1717
-
1818
directory: mftf
1919
repository: magento/magento2-functional-testing-framework
20-
branch: develop
20+
branch: master
2121
filter: true
2222
-
2323
directory: page-builder

Gemfile

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,20 @@ source 'https://rubygems.org'
44

55
gem 'devdocs', git: 'https://github.com/magento-devdocs/devdocs-theme.git'
66
gem 'jekyll'
7+
gem 'whatsup_github'
78

8-
gem 'wdm' if Gem.win_platform?
9+
gem 'wdm', platform: :mswin
910

1011
group :test do
1112
gem 'html-proofer'
1213
gem 'launchy'
1314
end
1415

16+
group :optimization do
17+
gem 'image_optim'
18+
gem 'image_optim_pack'
19+
end
20+
1521
group :jekyll_plugins do
1622
gem 'jekyll-algolia', '~> 1.0'
1723
gem 'jekyll-redirect-from'

Gemfile.lock

Lines changed: 44 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
GIT
22
remote: https://github.com/magento-devdocs/devdocs-theme.git
3-
revision: 20f1b8529a01f4585117f73913475072e73f9cab
3+
revision: 5ce6bf94dbf827682b1f83d5e3c4fbc4c4f69478
44
specs:
5-
devdocs (0.0.1)
5+
devdocs (2)
66
jekyll (>= 3.3)
77

88
GEM
@@ -30,9 +30,13 @@ GEM
3030
ethon (0.12.0)
3131
ffi (>= 1.3.0)
3232
eventmachine (1.2.7)
33-
ffi (1.10.0)
33+
exifr (1.3.6)
34+
faraday (0.15.4)
35+
multipart-post (>= 1.2, < 3)
36+
ffi (1.11.1)
3437
filesize (0.2.0)
3538
forwardable-extended (2.6.0)
39+
fspath (3.1.1)
3640
html-proofer (3.9.3)
3741
activesupport (>= 4.2, < 6.0)
3842
addressable (~> 2.3)
@@ -46,7 +50,18 @@ GEM
4650
httpclient (2.8.3)
4751
i18n (0.9.5)
4852
concurrent-ruby (~> 1.0)
49-
jekyll (3.8.5)
53+
image_optim (0.26.4)
54+
exifr (~> 1.2, >= 1.2.2)
55+
fspath (~> 3.0)
56+
image_size (>= 1.5, < 3)
57+
in_threads (~> 1.3)
58+
progress (~> 3.0, >= 3.0.1)
59+
image_optim_pack (0.5.3)
60+
fspath (>= 2.1, < 4)
61+
image_optim (~> 0.19)
62+
image_size (2.0.1)
63+
in_threads (1.5.2)
64+
jekyll (3.8.6)
5065
addressable (~> 2.4)
5166
colorator (~> 1.0)
5267
em-websocket (~> 0.5)
@@ -94,38 +109,55 @@ GEM
94109
mercenary (0.3.6)
95110
mini_portile2 (2.3.0)
96111
minitest (5.11.3)
112+
multipart-post (2.1.1)
113+
netrc (0.11.0)
97114
nokogiri (1.8.5)
98115
mini_portile2 (~> 2.3.0)
116+
octokit (4.14.0)
117+
sawyer (~> 0.8.0, >= 0.5.3)
99118
parallel (1.17.0)
100119
pathutil (0.16.2)
101120
forwardable-extended (~> 2.6)
102-
progressbar (1.10.0)
103-
public_suffix (3.0.3)
121+
progress (3.5.1)
122+
progressbar (1.10.1)
123+
public_suffix (3.1.1)
104124
rb-fsevent (0.10.3)
105125
rb-inotify (0.10.0)
106126
ffi (~> 1.0)
107-
rouge (3.3.0)
127+
rouge (3.5.1)
108128
ruby_dep (1.5.0)
109129
safe_yaml (1.0.5)
110-
sass (3.7.3)
130+
sass (3.7.4)
111131
sass-listen (~> 4.0.0)
112132
sass-listen (4.0.0)
113133
rb-fsevent (~> 0.9, >= 0.9.4)
114134
rb-inotify (~> 0.9, >= 0.9.7)
135+
sawyer (0.8.2)
136+
addressable (>= 2.3.5)
137+
faraday (> 0.8, < 2.0)
138+
thor (0.20.3)
115139
thread_safe (0.3.6)
116140
typhoeus (1.3.1)
117141
ethon (>= 0.9.0)
118142
tzinfo (1.2.5)
119143
thread_safe (~> 0.1)
120144
verbal_expressions (0.1.5)
121-
yell (2.1.0)
145+
wdm (0.1.1)
146+
whatsup_github (0.0.1)
147+
netrc (~> 0.10)
148+
octokit (~> 4.14)
149+
thor (~> 0.20)
150+
yell (2.2.0)
122151

123152
PLATFORMS
124153
ruby
154+
x86-mswin32
125155

126156
DEPENDENCIES
127157
devdocs!
128158
html-proofer
159+
image_optim
160+
image_optim_pack
129161
jekyll
130162
jekyll-algolia (~> 1.0)
131163
jekyll-optional-front-matter
@@ -134,6 +166,8 @@ DEPENDENCIES
134166
jekyll-sitemap
135167
jekyll-titles-from-headings
136168
launchy
169+
wdm
170+
whatsup_github
137171

138172
BUNDLED WITH
139-
1.17.2
173+
1.17.3

README.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -146,6 +146,38 @@ The following example will generate Magento 2.2 documentation only.
146146

147147
If you don't have the `_config.local.yml` file at the root of your `devdocs/` directory, the rake will generate all versions of the documentation.
148148

149+
### To build v2.0 documentation
150+
151+
Magento 2.0.18 was the final 2.0.x release. After March 2018, Magento 2.0.x stopped receiving security patches, quality fixes, and documentation updates.
152+
153+
To ensure the quality of our public documentation for versions of Magento that are still supported and to avoid potential confusion about 2.0.x support, we removed all 2.0.x content from our public documentation websites on May 31, 2019.
154+
155+
To build v2.0 documentation:
156+
157+
> Also, you can use the GitHub interface to read the source Markdown files instead of building the site locally. Navigate to the [`2.0`](https://github.com/magento/devdocs/tree/2.0) branch and click the file you want to view.
158+
159+
1. Add an entry for 2.0 in the `Docfile.yml` file.
160+
161+
```yaml
162+
-
163+
directory: guides/v2.0
164+
repository: magento/devdocs
165+
branch: 2.0
166+
filter: false
167+
```
168+
169+
1. Initialize the `2.0` branch in your local devdocs repository.
170+
171+
```shell
172+
rake init
173+
```
174+
175+
1. Run the preview command.
176+
177+
```shell
178+
rake preview
179+
```
180+
149181
## Build using Vagrant
150182

151183
You can deploy the devdocs site locally using [this Vagrant project](https://github.com/magento-devdocs/vagrant-for-magento-devdocs).

Rakefile

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,3 +60,12 @@ end
6060

6161
desc 'Pull docs from external repositories'
6262
task init: %w[multirepo:init]
63+
64+
desc 'Run checks (image optimization).'
65+
task check: %w[check:image_optim]
66+
67+
desc 'Generate data for the weekly digest.'
68+
task :whatsnew do
69+
print 'Generating data for the weekly digest: $ '.magenta
70+
sh 'whatsup_github'
71+
end

_config.checks.yml

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,27 @@
33
# For configuration defaults, refer to: https://github.com/gjtorikian/html-proofer/blob/master/lib/html-proofer/configuration.rb
44
#
55
html-proofer:
6+
# Do not check external links.
67
:disable_external: true
8+
9+
# Report only errors that fall within the 4xx status code range.
710
:only_4xx: true
11+
12+
# Ignores images with empty alt tags.
813
:empty_alt_ignore: true
9-
:allow_hash_ref: true
14+
15+
# Sort errors by description in the report
1016
:error_sort: :desc
17+
18+
# Use up to 3 parallel processes to speed up internal file checks.
1119
:parallel:
1220
:in_processes: 3
13-
:file_ignore:
14-
- !ruby/regexp /guides\/v2\.0/
15-
- !ruby/regexp /videos\//
21+
22+
# Ignore entirely the files which pathname matches a specified pattern
23+
# :file_ignore:
24+
# - guides/v2.0
25+
26+
# Ignore any link that includes a specified pattern
27+
# :url_ignore:
28+
# - !ruby/regexp /guides\/v2\.0/
29+

_config.index.yml

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Jekyll Algolia settings for indexing https://community.algolia.com/jekyll-algolia/options.html
2+
algolia:
3+
files_to_exclude:
4+
- guides/m1x/**/*.html
5+
- guides/m1x/**/*.md
6+
- swagger
7+
- redoc
8+
# Index HTML elements, especially code samples.
9+
nodes_to_index: 'p,li,td,code'
10+
# Override 10KB default and use our allowed max of 20KB
11+
max_record_size: 20000
12+
settings:
13+
attributesForFaceting:
14+
- searchable(functional_areas)
15+
- searchable(guide_version)
16+
- searchable(versionless)
17+
18+
# Disable the code blocks line numbers at indexing stage
19+
kramdown:
20+
syntax_highlighter_opts:
21+
span:
22+
line_numbers: false
23+
block:
24+
line_numbers: false

_config.yml

Lines changed: 6 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,6 @@ baseurl: ""
1919
#
2020
version: "2.3"
2121
versions:
22-
-
23-
name: "2.0"
24-
url: /guides/v2.0/
2522
-
2623
name: "2.1"
2724
url: /guides/v2.1/
@@ -77,7 +74,7 @@ defaults:
7774
path: mftf/docs
7875
values:
7976
group: mftf
80-
github_files: https://github.com/magento/magento2-functional-testing-framework/blob/develop/
77+
github_files: https://github.com/magento/magento2-functional-testing-framework/blob/master/
8178
github_repo: https://github.com/magento/magento2-functional-testing-framework/
8279
functional_areas:
8380
- Test
@@ -105,11 +102,6 @@ defaults:
105102
group: module-reference-guide-2_3
106103
github_link: false
107104
feedback_link: false
108-
-
109-
scope:
110-
path: guides/v2.0
111-
values:
112-
sitemap: false
113105
-
114106
scope:
115107
path: guides/v2.1
@@ -175,25 +167,20 @@ kramdown:
175167
toc_levels: 2..3
176168
syntax_highlighter_opts:
177169
css_class: highlighter
170+
span:
171+
line_numbers: false
172+
block:
173+
line_numbers: true
178174

179175
# Search engine settings. For more details, refer to https://github.com/algolia/jekyll-algolia
180176
#
181177
algolia:
182178
application_id: E642SEDTHL
183179
index_name: devdocs
184180
api_key: d2d0f33ab73e291ef8d88d8b565e754c
185-
files_to_exclude:
186-
- guides/m1x/**/*.html
187-
- guides/m1x/**/*.md
188-
- swagger
189-
- redoc
190-
# Index HTML elements, especially code samples.
191-
nodes_to_index: 'p,li,td,code'
192-
# Override 10KB default and use our allowed max of 20KB
193-
max_record_size: 20000
194181

195182
google:
196-
analytics: UA-66243208-1
183+
gtm: GTM-KRCLXBB
197184

198185
# Toggles the _plugin/html-check-hook.rb script that checks links in the generated HTML
199186
#
@@ -206,10 +193,6 @@ check_links: true
206193
# Magento 2 repository variable
207194
mage2bloburl: https://github.com/magento/magento2/blob
208195

209-
# 2.0 variables
210-
gdeurl: /guides/v2.0/
211-
githuburl: https://github.com/magento/devdocs/tree/master/guides/v2.0/
212-
213196
# 1.x variables
214197
m1xgdeurl: /guides/m1x
215198
m1xgithuburl: https://github.com/magento/devdocs/blob/master

0 commit comments

Comments
 (0)