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

Commit 91c869e

Browse files
authored
Merge branch 'master' into imported-BarnyShergold-devdocs-9358
2 parents d6414fe + 452e698 commit 91c869e

File tree

310 files changed

+2791
-38159
lines changed

Some content is hidden

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

310 files changed

+2791
-38159
lines changed

.github/CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -148,6 +148,6 @@ You can provide feedback using the following options:
148148
Have a question? Need help? Magento DevDocs, Maintainers, and other Contributors are available through:
149149

150150
- [Slack](https://magentocommeng.slack.com/archives/CAN932A3H) ([Join us](https://opensource.magento.com/slack))
151-
- [Twitter @MagentoDevDocs](https://twitter.com/MagentoDevDocs)
151+
- [Twitter @AdobeCommrcDocs](https://twitter.com/AdobeCommrcDocs)
152152

153153
Thank you for contributing your brilliance to Magento DevDocs!!

.github/ISSUE_TEMPLATE.md

Lines changed: 0 additions & 25 deletions
This file was deleted.

.github/workflows/linter.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ jobs:
5555
# Run Linter against code base #
5656
################################
5757
- name: Lint Code Base
58-
uses: github/super-linter@v4
58+
uses: github/super-linter@v4.8.7
5959
env:
6060
VALIDATE_ALL_CODEBASE: false
6161
DEFAULT_BRANCH: master

.ruby-version

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
ruby-2.7.2
1+
ruby-2.7.5

Gemfile.lock

Lines changed: 18 additions & 14 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: b1e43366e1fa7c7cd33a2213c6a9304f57536e8f
3+
revision: d7b7c5db1a65987873068a78aac045cb581ff0a3
44
specs:
5-
devdocs (16)
5+
devdocs (18)
66
jekyll (>= 4.0)
77

88
GEM
@@ -16,7 +16,7 @@ GEM
1616
algoliasearch (1.27.5)
1717
httpclient (~> 2.8, >= 2.8.3)
1818
json (>= 1.5.1)
19-
chef-utils (17.8.25)
19+
chef-utils (17.9.26)
2020
concurrent-ruby
2121
colorator (1.1.0)
2222
concurrent-ruby (1.1.9)
@@ -27,25 +27,29 @@ GEM
2727
ffi (>= 1.15.0)
2828
eventmachine (1.2.7)
2929
exifr (1.3.9)
30-
faraday (1.8.0)
30+
faraday (1.9.3)
3131
faraday-em_http (~> 1.0)
3232
faraday-em_synchrony (~> 1.0)
3333
faraday-excon (~> 1.1)
34-
faraday-httpclient (~> 1.0.1)
34+
faraday-httpclient (~> 1.0)
35+
faraday-multipart (~> 1.0)
3536
faraday-net_http (~> 1.0)
36-
faraday-net_http_persistent (~> 1.1)
37+
faraday-net_http_persistent (~> 1.0)
3738
faraday-patron (~> 1.0)
3839
faraday-rack (~> 1.0)
39-
multipart-post (>= 1.2, < 3)
40+
faraday-retry (~> 1.0)
4041
ruby2_keywords (>= 0.0.4)
4142
faraday-em_http (1.0.0)
4243
faraday-em_synchrony (1.0.0)
4344
faraday-excon (1.1.0)
4445
faraday-httpclient (1.0.1)
46+
faraday-multipart (1.0.2)
47+
multipart-post (>= 1.2, < 3)
4548
faraday-net_http (1.0.1)
4649
faraday-net_http_persistent (1.2.0)
4750
faraday-patron (1.0.0)
4851
faraday-rack (1.0.0)
52+
faraday-retry (1.0.3)
4953
ffi (1.15.4)
5054
filesize (0.2.0)
5155
forwardable-extended (2.6.0)
@@ -132,18 +136,18 @@ GEM
132136
mixlib-config (>= 2.2.1, < 4)
133137
mixlib-shellout
134138
mercenary (0.4.0)
135-
mini_portile2 (2.6.1)
139+
mini_portile2 (2.7.1)
136140
mixlib-cli (2.1.8)
137141
mixlib-config (3.0.9)
138142
tomlrb
139143
mixlib-shellout (3.2.5)
140144
chef-utils
141145
multipart-post (2.1.1)
142146
netrc (0.11.0)
143-
nokogiri (1.12.5)
144-
mini_portile2 (~> 2.6.1)
147+
nokogiri (1.13.0)
148+
mini_portile2 (~> 2.7.0)
145149
racc (~> 1.4)
146-
nokogiri (1.12.5-x86_64-darwin)
150+
nokogiri (1.13.0-x86_64-darwin)
147151
racc (~> 1.4)
148152
octokit (4.21.0)
149153
faraday (>= 0.9)
@@ -171,7 +175,7 @@ GEM
171175
faraday (> 0.8, < 2.0)
172176
terminal-table (2.0.0)
173177
unicode-display_width (~> 1.1, >= 1.1.1)
174-
thor (1.1.0)
178+
thor (1.2.1)
175179
tomlrb (2.0.1)
176180
typhoeus (1.4.0)
177181
ethon (>= 0.9.0)
@@ -187,8 +191,8 @@ GEM
187191
PLATFORMS
188192
ruby
189193
x86-mswin32
190-
x86_64-darwin-18
191194
x86_64-darwin-19
195+
x86_64-darwin-21
192196

193197
DEPENDENCIES
194198
devdocs!
@@ -209,4 +213,4 @@ DEPENDENCIES
209213
whatsup_github
210214

211215
BUNDLED WITH
212-
2.2.15
216+
2.1.4

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -169,4 +169,4 @@ If you have questions, open an issue and ask us. We're looking forward to hearin
169169
170170
- [Slack](https://magentocommeng.slack.com/archives/CAN932A3H) ([Join us](https://opensource.magento.com/slack))
171171
- [Visit our wiki](https://github.com/magento/devdocs/wiki)
172-
- <a href="https://twitter.com/MagentoDevDocs" class="twitter-follow-button" data-show-count="false">Twitter @MagentoDevDocs</a>
172+
- <a href="https://twitter.com/AdobeCommrcDocs" class="twitter-follow-button" data-show-count="false">Twitter @AdobeCommrcDocs</a>

Rakefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ desc "Same as 'rake', 'rake preview'"
2424
task default: %w[preview]
2525

2626
desc "Same as 'test:report'"
27-
task test: %w[test:md test:report]
27+
task test: %w[test:md test:report test:unused_images test:unused_includes]
2828

2929
desc 'Preview the devdocs locally'
3030
task preview: %w[install clean] do

rakelib/test.rake

Lines changed: 31 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -63,11 +63,16 @@ namespace :test do
6363
puts 'No issues found'.green
6464
end
6565

66-
desc 'Find unused images'
66+
desc 'Find unused images. To exclude by regex pattern, use the "exclude_img" argument. Example of excluding a "layout" directory: "rake test:unused_includes exclude_img=/layout/"'
6767
task :unused_images do
68-
puts 'Running a task for finding unused images'.magenta
69-
images = Dir['src/**/*.{png,svg,jpeg,jpg,ico}']
68+
puts 'Running a task for finding unused images (png,svg,jpeg,jpg,ico)'.magenta
69+
images = FileList['src/**/*.{png,svg,jpeg,jpg,ico}']
70+
7071
puts "The project contains a total of #{images.size} images."
72+
73+
exclude = ENV['exclude_img']
74+
images.exclude(/#{exclude}/) if exclude
75+
7176
puts 'Checking for unlinked images...'
7277
Dir['src/**/*.{md,html,js,css}'].each do |file|
7378
# Exclude symmlinks
@@ -76,33 +81,41 @@ namespace :test do
7681
images.delete_if { |image| File.read(file).include?(File.basename(image)) }
7782
end
7883

79-
abort 'No unlinked images' if images.empty?
80-
81-
images.each do |image|
82-
puts "No links for #{image}".yellow
84+
if images.empty?
85+
puts 'No unlinked images'.green
86+
else
87+
images.each do |image|
88+
puts "No links for #{image}".yellow
89+
end
90+
puts "Found #{images.size} dangling images".red
8391
end
84-
puts "Found #{images.size} dangling images".red
8592
end
8693

87-
desc 'Find unused includes'
94+
desc 'Find unused includes. To exclude by regex pattern, use the "exclude_incl" argument. Example of excluding a "layout" directory: "rake test:unused_includes exclude_incl=/layout/"'
8895
task :unused_includes do
8996
puts 'Running a task to find unused _includes'.magenta
90-
includes = Dir['src/_includes/**/*']
97+
includes = FileList['src/_includes/**/*']
98+
9199
puts "The project contains a total of #{includes.size} includes"
92-
puts 'The following includes are not linked:'
100+
101+
exclude = ENV['exclude_incl']
102+
includes.exclude(/#{exclude}/) if exclude
103+
93104
Dir['src/**/*.{md,html}'].each do |file|
94-
# Exclude symmlinks
95105
next if File.symlink? file
96106

97107
includes.delete_if { |include| File.read(file).include?(File.basename(include)) }
98108
end
99109

100-
abort 'No unlinked includes' if includes.empty?
101-
102-
includes.each do |include|
103-
puts "No links for #{include}".yellow
110+
if includes.empty?
111+
puts 'No unlinked includes'.green
112+
else
113+
puts 'The following includes are not linked:'
114+
includes.each do |include|
115+
puts "No links for #{include}".yellow
116+
end
117+
puts "Found #{includes.size} unlinked includes".red
118+
puts 'Be careful removing include files. Some include files, such as those in the layout/** directory, may not be linked in the project, but may be used implicitly by the doc theme.'.bold
104119
end
105-
puts "Found #{includes.size} unlinked includes".red
106-
puts 'Be careful removing include files. Some include files, such as those in the layout/** directory, may not be linked in the project, but may be used implicitly by the doc theme.'.bold
107120
end
108121
end

src/_data/core-releases.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -172,7 +172,7 @@
172172
}
173173
}
174174
],
175-
"end-of-support": "2022-04-??"
175+
"end-of-support": "2022-09-08"
176176
},
177177
"2.2": {
178178
"releases": [

src/_data/main-nav.yml

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
---
12
- label: Cloud
23
children:
34

@@ -65,8 +66,13 @@
6566
url: /extensions/
6667
versionless: true
6768

69+
- label: Software Update Guide
70+
url: https://experienceleague.adobe.com/docs/commerce-operations/upgrade-guide/overview.html
71+
exclude_versions: ["2.3"]
72+
6873
- label: Software Update Guide
6974
url: /comp-mgr/bk-compman-upgrade-guide.html
75+
exclude_versions: ["2.4"]
7076

7177
- label: Configuration Guide
7278
url: /config-guide/bk-config-guide.html
@@ -83,6 +89,10 @@
8389
- label: Command-line Tools Reference
8490
url: /reference/cli/magento.html
8591

92+
- label: Tools
93+
url: /quality-patches/tool.html
94+
versionless: true
95+
8696
- label: Development
8797
children:
8898

@@ -160,7 +170,6 @@
160170
url: /mbi/docs/getting-started.html
161171
versionless: true
162172

163-
164173
- label: Testing
165174
children:
166175

@@ -183,6 +192,8 @@
183192
- label: Web API Functional Testing
184193
url: /get-started/web-api-functional-testing.html
185194

195+
- separator: true
196+
186197
- label: Functional Areas
187198
children:
188199

0 commit comments

Comments
 (0)