Skip to content

Commit 3359e14

Browse files
sreicheladdison74
sreichel
and
addison74
authored
Add spellcheck to documentation (#4628)
* added spell check for docs * added .wordlist.txt * wording [skip ci] * test * typo * test * test * test * test * test * test * test * wordlist * test * test * test * wordlist * wordlist * wordlist * wordlist * typos * wordlist * link * fixes * fixes * fixes * fixes * fixes * rector: ClassConstantToSelfClassRector * link * typos * typos * code * links * modules * links * fixes * fixes * fixes * fixes * fixes * fixes * fixes * fixes * fixes * fixes * fixes * fixes * fixes * fixes * fixes * fixes * fixes * fixes * fixes * fixes * fixes * fixes * fixes * fixes * fixes * fixes * fixes * fixes * fixes * fixes * fixes * fixes * fixes * fixes * fixes * fixes * fixes * fixes * fixes * fixes * fixes * fixes * fixes * fixes * PhpStan fixes * PhpStan fixes * PhpStan fixes * PhpStan fixes * PhpStan fixes * PhpStan fixes * PhpStan fixes * PhpStan fixes * PhpStan fixes * fixes * fixes * fixes * fixes * fixes * fixes * fixes * fixes * Update .github/SECURITY.md Co-authored-by: Addison <[email protected]> * typos? * typo - thanks @pauldpauld * typos - thanks @pauldpauld * workflow labels * workflow labels * workflow labels --------- Co-authored-by: Addison <[email protected]>
1 parent 53ae92c commit 3359e14

File tree

88 files changed

+861
-717
lines changed

Some content is hidden

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

88 files changed

+861
-717
lines changed

‎.github/SECURITY.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ We will keep the details of your security vulnerability report private and only
1616

1717
To report a vulnerability, please *DO NOT* open a public Issue or Pull Request.
1818

19-
Please email your security vulnerability report to [email protected] along with your Github user name so that once we create a security advisory you may be added to it as a collaborator for further review.
19+
Please email your security vulnerability report to [email protected] along with your GitHub username so that once we create a security advisory you may be added to it as a collaborator for further review.
2020

2121
We will review the advisory and work with you to find a suitable solution. We will publicly disclose the vulnerability once a patch is prepared and our community and partners have an easy path forward to apply the patch promptly. We will be sure to give you credit for the vulnerability discovery unless you request otherwise.
2222

‎.github/spellcheck-usernames.txt

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
addison
2+
bucha
3+
colinmollenhour
4+
fballiano
5+
Flyingmana
6+
kiatng
7+
robertrogge
8+
sreichel

‎.github/spellcheck-wordlist.txt

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
ACL
2+
ActionScript
3+
bool
4+
Braintree
5+
Browsersync
6+
Captcha
7+
CLI
8+
Cloudflare
9+
CMS
10+
Cron
11+
CVE
12+
CodeQL
13+
DevOps
14+
DDEV
15+
DNS
16+
DocBlock
17+
EAV
18+
Emmet
19+
FireGento
20+
FPC
21+
Gitpod
22+
HiPay
23+
Homebrew
24+
HMAC
25+
ImageMagick
26+
IntelliSense
27+
jQuery
28+
JS
29+
JSON
30+
LTS
31+
macOS
32+
Magento
33+
magerun
34+
Mailpit
35+
mkcert
36+
MkDocs
37+
Matomo
38+
MTF
39+
nginx
40+
npm
41+
OAuth
42+
OpenMage
43+
OpenNode
44+
PageSpeed
45+
PHPCompatibility
46+
PHPCS
47+
PHPMD
48+
phpMyAdmin
49+
PHPStan
50+
PhpStorm
51+
PHPUnit
52+
PLAINTEXT
53+
RCE
54+
reCaptcha
55+
Redis
56+
RPC
57+
RSS
58+
RWD
59+
SCSS
60+
SHA
61+
SMTP
62+
SSL
63+
TinyMCE
64+
toc
65+
URI
66+
Varien
67+
VMware
68+
WAMP
69+
WebP
70+
WSDL
71+
WSL
72+
XAMPP
73+
Xdebug
74+
XSS
75+
Zend
76+
ZF
77+

‎.github/spellcheck.yml

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
matrix:
2+
- name: Markdown
3+
expect_match: false
4+
apsell:
5+
mode: en
6+
dictionary:
7+
wordlists:
8+
- .github/spellcheck-usernames.txt
9+
- .github/spellcheck-wordlist.txt
10+
output: wordlist.dic
11+
encoding: utf-8
12+
pipeline:
13+
- pyspelling.filters.markdown:
14+
markdown_extensions:
15+
- markdown.extensions.extra:
16+
- pyspelling.filters.html:
17+
comments: false
18+
attributes:
19+
- alt
20+
ignores:
21+
- ':matches(code, pre)'
22+
- ':matches(.magiclink)'
23+
- ':matches(.events-list-table + table)'
24+
- 'a'
25+
- 'code'
26+
- 'pre'
27+
- 'blockquote'
28+
sources:
29+
- 'docs/**/*.md'

‎.github/workflows/check-files.yml

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,9 @@ on:
3939
phpunit:
4040
description: "Count changed PHPUnit files"
4141
value: ${{ jobs.check.outputs.phpunit }}
42+
markdown:
43+
description: "Count changed markdown files"
44+
value: ${{ jobs.check.outputs.markdown }}
4245
cypress:
4346
description: "Count changed Cypress files"
4447
value: ${{ jobs.check.outputs.cypress }}
@@ -52,6 +55,7 @@ jobs:
5255
outputs:
5356
composer: ${{ steps.changes-composer.outputs.composer }}
5457
js: ${{ steps.changes-js.outputs.js }}
58+
markdown: ${{ steps.changes-php.outputs.markdown }}
5559
php: ${{ steps.changes-php.outputs.php }}
5660
phtml: ${{ steps.all.outputs.phtml }}
5761
xml: ${{ steps.changes-xml.outputs.xml }}
@@ -88,6 +92,7 @@ jobs:
8892
files: |
8993
composer.*
9094
*.php
95+
**/*.md
9196
**/*.php
9297
**/*.phtml
9398
**/*.xml
@@ -199,6 +204,14 @@ jobs:
199204
echo "$count PHPUnit file(s) changed"
200205
echo "phpunit=$count" >> $GITHUB_OUTPUT
201206
207+
- name: Check if Markdown files changed
208+
id: changes-markdown
209+
if: steps.changed-files-specific.outputs.any_modified == 'true'
210+
run: |
211+
count="$(grep -oE "*.md" <<< "${{ steps.changed-files-specific.outputs.all_modified_files }}" | wc -l)"
212+
echo "$count Markdown file(s) changed"
213+
echo "markdown=$count" >> $GITHUB_OUTPUT
214+
202215
- name: Check if Cypress files changed
203216
id: changes-cypress
204217
if: steps.changed-files-specific.outputs.any_modified == 'true'

‎.github/workflows/spellcheck.yml

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
name: Markdown
2+
3+
on:
4+
workflow_call:
5+
workflow_dispatch:
6+
7+
jobs:
8+
spellcheck:
9+
name: Markdown
10+
runs-on: [ubuntu-latest]
11+
12+
steps:
13+
- name: Checkout
14+
uses: actions/checkout@v4
15+
- name: Check Spelling
16+
uses: rojopolis/[email protected]
17+
with:
18+
config_path: .github/spellcheck.yml
19+
task_name: Markdown

‎.github/workflows/workflow.yml

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ on:
99
- '**.php'
1010
- '**.phtml'
1111
- '**.js'
12+
- '**.md'
1213
- '**.xml'
1314
- '.php-cs-fixer.dist.php'
1415
- '.phpcs.dist.xml'
@@ -25,6 +26,7 @@ on:
2526
- '**.php'
2627
- '**.phtml'
2728
- '**.js'
29+
- '**.md'
2830
- '**.xml'
2931
- '.php-cs-fixer.dist.php'
3032
- '.phpcs.dist.xml'
@@ -128,7 +130,7 @@ jobs:
128130
uses: ./.github/workflows/rector.yml
129131

130132
unit_tests:
131-
name: PHPUnit Tests
133+
name: PHPUnit
132134
needs: [check, php-cs-fixer]
133135
if: |
134136
needs.check.outputs.php > 0 ||
@@ -137,6 +139,14 @@ jobs:
137139
needs.check.outputs.workflow > 0
138140
uses: ./.github/workflows/phpunit.yml
139141

142+
spellcheck:
143+
name: Spellcheck
144+
needs: [check]
145+
if: |
146+
needs.check.outputs.markdown > 0 ||
147+
needs.check.outputs.workflow > 0
148+
uses: ./.github/workflows/spellcheck.yml
149+
140150
cypress:
141151
name: Cypress E2E Tests
142152
needs: [check, php-cs-fixer]

‎docs/content/api/rest/common_http_status_codes.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,16 +8,16 @@ The Magento API attempts to return appropriate HTTP status codes for all request
88

99
The following table contains possible common HTTP status codes:
1010

11-
| Status Code | Message |
12-
|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
13-
| 200 OK | - |
14-
| 201 Created | Resource was partially created |
15-
| 207 Multi-Status | - |
16-
| 400 Bad Request | Resource data pre-validation error.<br>Resource data invalid.<br>The request data is invalid.<br>Resource collection paging error.<br>The paging limit exceeds the allowed number.<br>Resource collection ordering error.<br>Resource collection filtering error.<br>Resource collection including additional attributes error. |
17-
| 403 Forbidden | Access denied. |
18-
| 404 Not Found | Resource not found. |
19-
| 405 Method Not Allowed | Resource does not support method.<br>Resource method not implemented yet. |
20-
| 500 Internal Error | Unhandled simple errors.<br>Resource internal error. |
11+
| Status Code | Message |
12+
|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
13+
| 200 OK | - |
14+
| 201 Created | Resource was partially created |
15+
| 207 Multi-Status | - |
16+
| 400 Bad Request | Resource data before validation error.<br>Resource data invalid.<br>The request data is invalid.<br>Resource collection paging error.<br>The paging limit exceeds the allowed number.<br>Resource collection ordering error.<br>Resource collection filtering error.<br>Resource collection including additional attributes error. |
17+
| 403 Forbidden | Access denied. |
18+
| 404 Not Found | Resource not found. |
19+
| 405 Method Not Allowed | Resource does not support method.<br>Resource method not implemented yet. |
20+
| 500 Internal Error | Not handled simple errors.<br>Resource internal error. |
2121

2222
## Error Messages
2323

‎docs/content/api/rest/get_filters.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,19 +4,19 @@ _JSON responses on this page contributed by Tim Reynolds._
44

55
Some requests use GET parameters in the URL. These are as follows:
66

7-
## filter
7+
## `filter`
88

99
Specifies the filters for returned data.
1010

11-
## page
11+
## `page`
1212

1313
Specifies the page number which items will be returned.
1414

1515
!!! example
1616
```
1717
https://om.ddev.site/api/rest/products?page=1
1818
```
19-
## order, dir
19+
## `order`, `dir`
2020

2121
Specifies the sort order of returned items and the order direction: `asc` - returns items in the ascending order; `dsc` - returns items in the descending order.
2222

@@ -25,7 +25,7 @@ Specifies the sort order of returned items and the order direction: `asc` - retu
2525
https://om.ddev.site/api/rest/products?order=name&dir=dsc
2626
https://om.ddev.site/api/rest/products?order=name&dir=asc
2727
```
28-
## limit
28+
## `limit`
2929

3030
Limits the number of returned items in the response. Note that by default, 10 items are returned in the response. The maximum number is 100 items.
3131

@@ -34,7 +34,7 @@ Limits the number of returned items in the response. Note that by default, 10 it
3434
https://om.ddev.site/api/rest/products?limit=2
3535
```
3636

37-
## neq
37+
## `neq`
3838

3939
"not equal to" - returns items with the specified attribute that is not equal to the defined value.
4040

@@ -43,7 +43,7 @@ Limits the number of returned items in the response. Note that by default, 10 it
4343
https://om.ddev.site/api/rest/products?filter[1][attribute]=entity_id&filter[1][neq]=3
4444
```
4545

46-
## in
46+
## `in`
4747

4848
"equals any of" - returns items that are equal to the item(s) with the specified attribute(s).
4949

@@ -52,7 +52,7 @@ Limits the number of returned items in the response. Note that by default, 10 it
5252
https://om.ddev.site/api/rest/products?filter[1][attribute]=entity_id&filter[1][in]=3
5353
```
5454

55-
## nin
55+
## `nin`
5656

5757
"not equals any of" - returns items excluding the item with the specified attribute.
5858

@@ -61,7 +61,7 @@ Limits the number of returned items in the response. Note that by default, 10 it
6161
https://om.ddev.site/api/rest/products?filter[1][attribute]=entity_id&filter[1][nin]=3
6262
```
6363

64-
## gt
64+
## `gt`
6565

6666
"greater than" - returns items with the specified attribute that is greater than the defined value.
6767

@@ -71,7 +71,7 @@ Limits the number of returned items in the response. Note that by default, 10 it
7171
https://om.ddev.site/api/rest/products?filter[1][attribute]=price&filter[1][gt]=300
7272
```
7373

74-
## lt
74+
## `lt`
7575

7676
"less than" - returns items with the specified attribute that is less than the defined value.
7777

@@ -80,7 +80,7 @@ Limits the number of returned items in the response. Note that by default, 10 it
8080
https://om.ddev.site/api/rest/products?filter[1][attribute]=entity_id&filter[1][lt]=4
8181
```
8282

83-
## from, to
83+
## `from`, `to`
8484

8585
Specifies the range of attributes according to which items will be returned.
8686

@@ -90,9 +90,9 @@ Specifies the range of attributes according to which items will be returned.
9090
https://om.ddev.site/api/rest/products?filter[1][attribute]=price&filter[1][from]=150&filter[1][to]=350
9191
```
9292

93-
## Whitespaces
93+
## White-spaces
9494

95-
If the attribute value consists of several words separated by a whitespace, the '%20' sign is used:
95+
If the attribute value consists of several words separated by a white-space, the '%20' sign is used:
9696

9797
!!! example
9898
```

0 commit comments

Comments
 (0)