Skip to content

Commit

Permalink
Merge branch 'main' into extend-the-developer-tools-updatee
Browse files Browse the repository at this point in the history
  • Loading branch information
rebloor authored Sep 13, 2024
2 parents 77f4c99 + 3994f73 commit 9cde701
Show file tree
Hide file tree
Showing 460 changed files with 5,952 additions and 2,971 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/auto-cleanup-bot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ jobs:
- name: Create PR with only fixable issues
if: success()
uses: peter-evans/create-pull-request@v6
uses: peter-evans/create-pull-request@v7
with:
commit-message: "chore: auto-fix Markdownlint, Prettier, and front-matter issues"
branch: markdownlint-auto-cleanup
Expand All @@ -49,7 +49,7 @@ jobs:

- name: Create PR with notice on unfixed issues
if: failure()
uses: peter-evans/create-pull-request@v6
uses: peter-evans/create-pull-request@v7
with:
commit-message: "chore: auto-fix Markdownlint, Prettier, and front-matter issues"
branch: markdownlint-auto-cleanup
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/auto-merge.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ on:
jobs:
auto-merge:
runs-on: ubuntu-latest
if: github.actor == 'dependabot[bot]'
if: github.event.pull_request.user.login == 'dependabot[bot]'
steps:
- uses: ahmadnassri/[email protected]
with:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/interfacedata-updater.yml
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ jobs:
run: node scripts/update-interface-data.js ../webref/

- name: Create pull request
uses: peter-evans/create-pull-request@v6
uses: peter-evans/create-pull-request@v7
with:
path: mdn-content
token: ${{ secrets.AUTOMERGE_TOKEN }}
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/pr-check-lint_content.yml
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ jobs:
run: |
# Use the GitHub API to get the list of changed files
# documentation: https://docs.github.com/rest/commits/commits#compare-two-commits
DIFF_DOCUMENTS=$(gh api repos/{owner}/{repo}/compare/${{ env.BASE_SHA }}...${{ env.HEAD_SHA }} \
DIFF_DOCUMENTS=$(gh api repos/{owner}/{repo}/compare/${BASE_SHA}...${HEAD_SHA} \
--jq '.files | .[] | select(.status|IN("added", "modified", "renamed", "copied", "changed")) | .filename')
# filter out files that are not markdown
DIFF_DOCUMENTS=$(echo "${DIFF_DOCUMENTS}" | egrep -i "^files/.*\.md$" | xargs)
Expand Down
18 changes: 9 additions & 9 deletions .github/workflows/pr-test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ jobs:
run: |
# Use the GitHub API to get the list of changed files
# documentation: https://docs.github.com/rest/commits/commits#compare-two-commits
DIFF_DOCUMENTS=$(gh api repos/{owner}/{repo}/compare/${{ env.BASE_SHA }}...${{ env.HEAD_SHA }} \
DIFF_DOCUMENTS=$(gh api repos/{owner}/{repo}/compare/${BASE_SHA}...${HEAD_SHA} \
--jq '.files | .[] | select(.status|IN("added", "modified", "renamed", "copied", "changed")) | .filename')
# filter out files that are not markdown files
Expand Down Expand Up @@ -97,27 +97,27 @@ jobs:
# you don't need that script as a writer. It's only used in CI
# and it can't use the default CONTENT_ROOT that gets set in
# package.json.
yarn build ${{ env.GIT_DIFF_CONTENT }}
yarn build $GIT_DIFF_CONTENT
echo "Disk usage size of the build"
du -sh ${{ env.BUILD_OUT_ROOT }}
du -sh $BUILD_OUT_ROOT
# Save the PR number into the build
echo ${{ github.event.number }} > ${{ env.BUILD_OUT_ROOT }}/NR
echo ${{ github.event.number }} > ${BUILD_OUT_ROOT}/NR
# Download the raw diff blob and store that inside the build
# directory.
# The purpose of this is for the PR Review Companion to later
# be able to use this raw diff file for the benefit of analyzing.
wget https://github.com/${{ github.repository }}/compare/${{ env.BASE_SHA }}...${{ env.HEAD_SHA }}.diff -O ${{ env.BUILD_OUT_ROOT }}/DIFF
wget https://github.com/${{ github.repository }}/compare/${BASE_SHA}...${HEAD_SHA}.diff -O ${BUILD_OUT_ROOT}/DIFF
- name: Merge static assets with built documents
if: ${{ env.GIT_DIFF_CONTENT }}
run: |
# Exclude the .map files, as they're used for debugging JS and CSS.
rsync -a --exclude "*.map" node_modules/@mdn/yari/client/build/ ${{ env.BUILD_OUT_ROOT }}
rsync -a --exclude "*.map" node_modules/@mdn/yari/client/build/ $BUILD_OUT_ROOT
# Show the final disk usage size of the build.
du -sh ${{ env.BUILD_OUT_ROOT }}
du -sh $BUILD_OUT_ROOT
- uses: actions/upload-artifact@v4
if: ${{ env.GIT_DIFF_CONTENT }}
Expand All @@ -128,7 +128,7 @@ jobs:
- name: Check changed files
if: ${{ env.GIT_DIFF_FILES }}
run: |
echo ${{ env.GIT_DIFF_FILES }}
echo $GIT_DIFF_FILES
export CONTENT_ROOT=$(pwd)/files
yarn filecheck ${{ env.GIT_DIFF_FILES }}
yarn filecheck $GIT_DIFF_FILES
40 changes: 23 additions & 17 deletions .github/workflows/spelling-check-bot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ jobs:
sync:
if: github.repository == 'mdn/content'
runs-on: ubuntu-latest
permissions:
issues: write

steps:
- uses: actions/checkout@v4
Expand All @@ -21,28 +23,32 @@ jobs:

- name: Run scripts
run: |
npm install
echo Running spelling check...
output=$(npx cspell --no-progress --gitignore --config .vscode/cspell.json "**/*.md" || exit 0)
echo "$output"
echo "OUTPUT<<EOF" >> $GITHUB_ENV
echo "$output" >> $GITHUB_ENV
echo "EOF" >> $GITHUB_ENV
- name: Create an issue
if [ -n "${output}" ]; then
output=$(node scripts/linkify-logs.js "${output}")
output=$(echo "$output" | sed 's/^/- /')
echo "$output"
echo "OUTPUT<<EOF" >> $GITHUB_ENV
echo "$output" >> $GITHUB_ENV
echo "EOF" >> $GITHUB_ENV
else
echo "No typos found! 🎉"
fi
- name: Report spellcheck errors
if: env.OUTPUT != ''
uses: dacbd/create-issue-action@main
with:
token: ${{ secrets.GITHUB_TOKEN }}
title: Weekly spelling check
body: |
run: |
issue=$(gh issue create --title "$TITLE" --label "$LABELS" --body "$BODY")
echo Issue URL ${issue}
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
TITLE: Weekly spelling check
LABELS: reported by automation,good first issue
BODY: |
Typos and unknown words:
```
${{ env.OUTPUT }}
```
> [!TIP]
> To exclude words from the spellchecker, you can add valid words (web technology terms or abbreviations) to the [terms-abbreviations.txt](https://github.com/mdn/content/blob/main/.vscode/terms-abbreviations.txt) dictionary for IDE autocompletion. To ignore strings that are not words (`AABBCC` in code, for instance), you can add them to [ignore-list.txt](https://github.com/mdn/content/blob/main/.vscode/ignore-list.txt).
env:
OUTPUT: ${{ env.OUTPUT }}
> To exclude words from the spellchecker, you can add valid words (web technology terms or abbreviations) to the [terms-abbreviations.txt](https://github.com/mdn/content/blob/main/.vscode/terms-abbreviations.txt) dictionary for IDE autocompletion. To ignore strings that are not words (\`AABBCC\` in code, for instance), you can add them to [ignore-list.txt](https://github.com/mdn/content/blob/main/.vscode/ignore-list.txt).
3 changes: 3 additions & 0 deletions .vscode/ignore-list.txt
Original file line number Diff line number Diff line change
Expand Up @@ -1123,6 +1123,7 @@ Digi
Digianswer
dignissim
Dijit
dimoulis
dinocons
dinodescr
Dinos
Expand Down Expand Up @@ -1663,6 +1664,7 @@ Freecodecamp
Freemium
Freetype
Freitag
Frida
fringilla
fringille
fromcharcode
Expand Down Expand Up @@ -2368,6 +2370,7 @@ JXON
Kadir
Kadlec
kaios
Kahlo
Kakao
Kaku
Kaply
Expand Down
12 changes: 7 additions & 5 deletions files/en-us/_redirects.txt
Original file line number Diff line number Diff line change
Expand Up @@ -844,7 +844,7 @@
/en-US/docs/CSS/transition-property /en-US/docs/Web/CSS/transition-property
/en-US/docs/CSS/transition-timing-function /en-US/docs/Web/CSS/transition-timing-function
/en-US/docs/CSS/unicode-bidi /en-US/docs/Web/CSS/unicode-bidi
/en-US/docs/CSS/uri /en-US/docs/Web/CSS/url
/en-US/docs/CSS/uri /en-US/docs/Web/CSS/url_value
/en-US/docs/CSS/used_value /en-US/docs/Web/CSS/used_value
/en-US/docs/CSS/user-ident /en-US/docs/Web/CSS/custom-ident
/en-US/docs/CSS/user-select /en-US/docs/Web/CSS/user-select
Expand Down Expand Up @@ -1085,7 +1085,7 @@
/en-US/docs/CSS:text-shadow /en-US/docs/Web/CSS/text-shadow
/en-US/docs/CSS:text-transform /en-US/docs/Web/CSS/text-transform
/en-US/docs/CSS:top /en-US/docs/Web/CSS/top
/en-US/docs/CSS:uri /en-US/docs/Web/CSS/url
/en-US/docs/CSS:uri /en-US/docs/Web/CSS/url_value
/en-US/docs/CSS:vertical-align /en-US/docs/Web/CSS/vertical-align
/en-US/docs/CSS:visibility /en-US/docs/Web/CSS/visibility
/en-US/docs/CSS:visible /en-US/docs/Web/CSS/visibility
Expand Down Expand Up @@ -11623,7 +11623,7 @@
/en-US/docs/Web/CSS/filter-function/path() /en-US/docs/Web/CSS/basic-shape/path
/en-US/docs/Web/CSS/filter-function/saturate() /en-US/docs/Web/CSS/filter-function/saturate
/en-US/docs/Web/CSS/filter-function/sepia() /en-US/docs/Web/CSS/filter-function/sepia
/en-US/docs/Web/CSS/filter-function/url /en-US/docs/Web/CSS/url
/en-US/docs/Web/CSS/filter-function/url /en-US/docs/Web/CSS/url_value
/en-US/docs/Web/CSS/fit-content() /en-US/docs/Web/CSS/fit-content_function
/en-US/docs/Web/CSS/flex-align /en-US/docs/Web/CSS/align-items
/en-US/docs/Web/CSS/flex-item-align /en-US/docs/Web/CSS/align-self
Expand Down Expand Up @@ -11660,6 +11660,7 @@
/en-US/docs/Web/CSS/linear-gradient() /en-US/docs/Web/CSS/gradient/linear-gradient
/en-US/docs/Web/CSS/margin-new /en-US/docs/Web/CSS/margin
/en-US/docs/Web/CSS/margin_collapsing /en-US/docs/Web/CSS/CSS_box_model/Mastering_margin_collapsing
/en-US/docs/Web/CSS/masonry-auto-flow /en-US/docs/Web/CSS/grid-auto-flow
/en-US/docs/Web/CSS/max() /en-US/docs/Web/CSS/max
/en-US/docs/Web/CSS/media /en-US/docs/Web/CSS/@media
/en-US/docs/Web/CSS/media/Bitmap /en-US/docs/Web/CSS/@media
Expand Down Expand Up @@ -11737,8 +11738,9 @@
/en-US/docs/Web/CSS/transform-function/translateY() /en-US/docs/Web/CSS/transform-function/translateY
/en-US/docs/Web/CSS/transform-function/translateZ() /en-US/docs/Web/CSS/transform-function/translateZ
/en-US/docs/Web/CSS/unicode-range /en-US/docs/Web/CSS/@font-face/unicode-range
/en-US/docs/Web/CSS/uri /en-US/docs/Web/CSS/url
/en-US/docs/Web/CSS/url() /en-US/docs/Web/CSS/url
/en-US/docs/Web/CSS/uri /en-US/docs/Web/CSS/url_value
/en-US/docs/Web/CSS/url /en-US/docs/Web/CSS/url_value
/en-US/docs/Web/CSS/url() /en-US/docs/Web/CSS/url_function
/en-US/docs/Web/CSS/user-ident /en-US/docs/Web/CSS/custom-ident
/en-US/docs/Web/CSS/var() /en-US/docs/Web/CSS/var
/en-US/docs/Web/CSS/visible /en-US/docs/Web/CSS/visibility
Expand Down
6 changes: 1 addition & 5 deletions files/en-us/_wikihistory.json
Original file line number Diff line number Diff line change
Expand Up @@ -86802,10 +86802,6 @@
"Heycam"
]
},
"Web/CSS/masonry-auto-flow": {
"modified": "2020-11-12T04:50:46.255Z",
"contributors": ["rachelandrew", "chrisdavidmills"]
},
"Web/CSS/math-style": {
"modified": "2020-12-12T22:36:34.292Z",
"contributors": ["sideshowbarker", "chrisdavidmills", "rachelandrew"]
Expand Down Expand Up @@ -90642,7 +90638,7 @@
"teoli"
]
},
"Web/CSS/url": {
"Web/CSS/url_value": {
"modified": "2020-12-11T11:18:33.507Z",
"contributors": [
"rachelandrew",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ A typical 3D scene in a game — even the simplest one — contains standard ite

To start developing with Three.js, you should make sure you are using a modern browser with good [WebGL](/en-US/docs/Web/API/WebGL_API) support, such as the latest Firefox or Chrome.

You can download the [latest Three.js library](https://github.com/mrdoob/three.js/archive/master.zip) and copy the minified version of Three.js from the uncompressed archive at `build/three.module.min.js` into your project.
You can download the [latest Three.js library](https://codeload.github.com/mrdoob/three.js/zip/refs/heads/master) and copy the minified version of Three.js from the uncompressed archive at `build/three.module.min.js` into your project.
Bear in mind that the archives include source files, which makes the download size approximately 350MB.

Alternatively, you can import Three.js [using a CDN or use Node.js](https://threejs.org/docs/#manual/en/introduction/Installation).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ ctx.closePath();

ctx.beginPath();
ctx.rect(160, 10, 100, 40);
ctx.strokeStyle = "rgba(0, 0, 255, 0.5)";
ctx.strokeStyle = "rgb(0 0 255 / 0.5)";
ctx.stroke();
ctx.closePath();
```
Expand Down
2 changes: 1 addition & 1 deletion files/en-us/glossary/etld/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ However, this does not work as a general rule, because many registrars allow org

Because this is a matter of the registrar's policies, it's impossible to tell algorithmically whether a given domain name suffix (like `ac.uk`) is publicly registrable or not. The [Public Suffix List](https://publicsuffix.org/) is a list of all suffixes under which organizations can directly register names: that is, it is a list of eTLDs.

The related concept **eTLD+1** means an eTLD plus the next part of the domain name. Because eTLDs are registrable, all domains with the same eTLD+1 are owned by the same organization.
The related concept **eTLD+1** means an eTLD plus the next part of the domain name. Because eTLD+1s are registrable, all domains with the same eTLD+1 are owned by the same organization.

For example, all the following are eTLD+1 domains:

Expand Down
2 changes: 1 addition & 1 deletion files/en-us/glossary/statement/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,5 +10,5 @@ In a computer programming language, a **statement** is a line of code commanding

## See also

- [Statement (computer science)](<https://en.wikipedia.org/wiki/Statement_(computer_science)>) on Wikipedia
- [JavaScript statements and declarations](/en-US/docs/Web/JavaScript/Reference/Statements)
- [Statement (computer science)](<https://en.wikipedia.org/wiki/Statement_(computer_science)>) on Wikipedia
2 changes: 1 addition & 1 deletion files/en-us/glossary/throttle/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ page-type: glossary-definition

Throttling is very similar to {{glossary("debounce", "debouncing")}}. The key difference is that when invocations happen continuously, throttling ensures that the operation is still performed at a certain maximum rate, while debouncing waits indefinitely until the invocations stop for a certain amount of time.

A typical use case of debouncing is when synchronizing with another constantly-updating state. Consider a function `onScrolled`, which listens for the [`scroll`](/en-US/docs/Web/API/Document/scroll_event) event. The `scroll` event may fire as often as every pixel scrolled, so the function will be called in very short intervals. If `onScrolled` is computationally expensive, earlier invocations might block later invocations from happening on time, or block other things from executing in the meantime, leading to a noticeable {{glossary("jank")}}. In this case, we can throttle `onScrolled`, such that it can only be called at most once every 10 milliseconds:
A typical use case of throttling is when synchronizing with another constantly-updating state. Consider a function `onScrolled`, which listens for the [`scroll`](/en-US/docs/Web/API/Document/scroll_event) event. The `scroll` event may fire as often as every pixel scrolled, so the function will be called in very short intervals. If `onScrolled` is computationally expensive, earlier invocations might block later invocations from happening on time, or block other things from executing in the meantime, leading to a noticeable {{glossary("jank")}}. In this case, we can throttle `onScrolled`, such that it can only be called at most once every 10 milliseconds:

1. The first call to `onScrolled` is known as the _leading edge_.
2. For every next call to `onScrolled`, if it is within 10 milliseconds from the first call, it is in the same "batch" as the first call.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ Here are some popular editors:
</td>
<td>
<a
href="https://ingorichter.github.io/BracketsExtensionTweetBot/"
href="https://ingo-richter.io/BracketsExtensionTweetBot/"
rel="external"
>Yes</a
>
Expand All @@ -104,8 +104,8 @@ Here are some popular editors:
<td>$99</td>
<td>Mac</td>
<td>
<a href="https://twitter.com/panic">Twitter</a>,
<a href="https://panic.com/qa" rel="external">Forum</a>,
<a href="https://x.com/panic">Twitter</a>,
<a href="https://help.panic.com/" rel="external">Forum</a>,
<a href="https://nova.app/help/">Online</a>
</td>
<td><a href="https://help.panic.com/nova/">eBook</a></td>
Expand Down Expand Up @@ -150,7 +150,7 @@ Here are some popular editors:
<td>Yes</td>
</tr>
<tr>
<td><a href="https://www.espressoapp.com/">Espresso</a></td>
<td><a href="https://espressoapp.com/">Espresso</a></td>
<td>Closed source</td>
<td>$99</td>
<td>Mac</td>
Expand Down Expand Up @@ -257,7 +257,7 @@ Here are some popular editors:
<td>Windows, Mac, Linux</td>
<td>
<a
href="https://www.sublimetext.com/forum/viewforum.php?f=3"
href="https://forum.sublimetext.com/c/technical-support"
rel="external"
>Forum</a
>
Expand All @@ -269,28 +269,25 @@ Here are some popular editors:
Unofficial</a
>
</td>
<td><a href="https://sublime.wbond.net/">Yes</a></td>
<td><a href="https://packagecontrol.io/">Yes</a></td>
</tr>
<tr>
<td><a href="https://macromates.com/" rel="external">TextMate</a></td>
<td>Closed source</td>
<td>$50</td>
<td>Mac</td>
<td>
<a href="https://twitter.com/macromates">Twitter</a>,
<a href="https://x.com/macromates">Twitter</a>,
<a href="https://webchat.freenode.net/?channels=textmate">IRC</a>,
<a href="https://lists.macromates.com/listinfo/textmate" rel="external"
<a href="https://lists.macromates.com/postorius/lists/textmate.lists.macromates.com/" rel="external"
>Mailing list</a
>, <a href="mailto:[email protected]">Email</a>
</td>
<td>
<a href="https://manual.macromates.com/en/">Online Manual</a>,
<a href="https://wiki.macromates.com/Main/HomePage" rel="external"
>Wiki</a
>
<a href="https://macromates.com/manual/en/">Online Manual</a>
</td>
<td>
<a href="https://wiki.macromates.com/Main/Plugins" rel="external"
<a href="https://macromates.com/textmate/manual/bundles" rel="external"
>Yes</a
>
</td>
Expand Down Expand Up @@ -428,7 +425,7 @@ If you like _lots_ of features and your editor is slowing down because of all yo
- [Aptana Studio](https://www.axway.com/en/aptana)
- [Eclipse](https://www.eclipse.org/)
- [Komodo IDE](https://www.activestate.com/products/komodo-ide/)
- [NetBeans IDE](https://netbeans.apache.org//)
- [NetBeans IDE](https://netbeans.apache.org/)
- [Visual Studio](https://visualstudio.microsoft.com/)
- [WebStorm](https://www.jetbrains.com/webstorm/)

Expand Down
Loading

0 comments on commit 9cde701

Please sign in to comment.