Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: integrations cleanup. #16217

Merged
Merged
Show file tree
Hide file tree
Changes from 55 commits
Commits
Show all changes
58 commits
Select commit Hold shift + click to select a range
37e3f0e
Docs: integrations cleanup. [short flow]
godai78 Apr 16, 2024
6574558
Docs: internal links. [short flow]
godai78 Apr 16, 2024
2470e78
Docs: preliminary React. [short flow]
godai78 Apr 17, 2024
c7eb577
Merge branch 'cc/5763-install-docs-structure' into cc/5763-integratio…
godai78 Apr 17, 2024
252d395
Technicals. [short flow]
godai78 Apr 17, 2024
2486c04
Merge branch 'cc/5763-install-docs-structure' into cc/5763-integratio…
godai78 Apr 17, 2024
f765394
Docs: React guide; minor fixes. [shorrt flow]
godai78 Apr 18, 2024
9715227
Docs: Vue3 guide; minor fixes. [short flow]
godai78 Apr 18, 2024
980bcec
Docs: Next.js guide; minor fixes. [short flow]
godai78 Apr 18, 2024
154a236
Docs: minor frameworks. [short flow]
godai78 Apr 18, 2024
969063f
Docs: Angular preliminaries. [short flow]
godai78 Apr 18, 2024
107e303
Merge branch 'cc/5763-install-docs-structure' into cc/5763-integratio…
gorzelinski Apr 25, 2024
2c37c35
Docs: Update the React Default integration to new installation methods.
gorzelinski Apr 25, 2024
0cd9d76
Docs: Fix spelling.
gorzelinski Apr 25, 2024
8c4e5d4
Docs: Update Quick start code snippets.
gorzelinski Apr 25, 2024
197c2fb
Docs: minor fix. [short flow]
godai78 Apr 26, 2024
10b3da2
Docs: Unify the usage of quotation marks in the React guide.
gorzelinski May 6, 2024
4e50284
Docs: Update the Vue guide to new installation methods.
gorzelinski May 6, 2024
64576b8
Docs: Fix indentations in the React guide
gorzelinski May 6, 2024
c2a6199
Docs: Update the Next.js guide to new installation methods.
gorzelinski May 8, 2024
1d50b96
Merge branch 'cc/5763-install-docs-structure' into cc/5763-integratio…
gorzelinski May 8, 2024
28ab88d
Docs: Update builder links in integrations.
gorzelinski May 8, 2024
c7312f7
Docs: minor update. [skip ci]
godai78 May 9, 2024
7ad2a35
Merge branch 'cc/5763-install-docs-structure' into cc/5763-integratio…
godai78 May 13, 2024
1cecb11
Merge branch 'cc/5763-install-docs-structure' into cc/5763-integratio…
godai78 May 13, 2024
dbff80a
Docs: Fix typos in the React guide.
gorzelinski May 13, 2024
a451407
Docs: Update the Angular guide to new installation methods.
gorzelinski May 13, 2024
2153aeb
Docs: Prepare a structure for the Vue 2 guide.
gorzelinski May 14, 2024
61fbe95
Docs: Unify subhedings in integrations.
gorzelinski May 14, 2024
96eae2d
Merge branch 'cc/5763-install-docs-structure' into cc/5763-integratio…
godai78 May 14, 2024
5bb7c73
Merge branch 'cc/5763-install-docs-structure' into cc/5763-integratio…
godai78 May 15, 2024
9e2027f
Docs: Add the component installation step to the Vue 3 guide.
gorzelinski May 14, 2024
e0ffdb5
Docs: Fix import in the Vue snippet.
gorzelinski May 14, 2024
9a5d304
Docs: Fix formatting in the Vue guide.
gorzelinski May 15, 2024
497bfc0
Docs: Add context to the Vue guide.
gorzelinski May 15, 2024
d3ac650
Docs: Update snippets in the Vue 3 guide.
gorzelinski May 15, 2024
c86bd54
Docs: Change the Angular guide structure.
gorzelinski May 15, 2024
08baca7
Docs: Unify collaboration sections across integrations.
gorzelinski May 15, 2024
af4bd74
Docs: Fix typo.
gorzelinski May 15, 2024
d7017fe
Docs: Add the localization section to the Vue 2 guide.
gorzelinski May 15, 2024
deb891c
Docs: Unify the localization section in Vue integrations.
gorzelinski May 15, 2024
69588ce
Docs: Update the Laravel integration guide to new installation methods.
gorzelinski May 16, 2024
e254765
Docs: Unify the setup sections.
gorzelinski May 17, 2024
f968ec8
Docs: Prepare a structure for the .NET integration.
gorzelinski May 17, 2024
2520e8c
Docs: Fix typo.
gorzelinski May 17, 2024
8d26fbc
Docs: Update the .NET integration guide to new installation methods.
gorzelinski May 17, 2024
2c5f7b0
Docs: Fix contraction.
gorzelinski May 17, 2024
c6e4c49
Merge branch 'cc/5763-install-docs-structure' into cc/5763-integratio…
godai78 May 20, 2024
20a48e3
Docs: Minor fixes in the Quick Start
gorzelinski May 20, 2024
83373da
Docs: Minor fixes in the Angular integration
gorzelinski May 20, 2024
cb85311
Docs: Minor fixes in the Next.js integration.
gorzelinski May 20, 2024
84fc14e
Docs: Minor fixes in the Vue 2 integration.
gorzelinski May 20, 2024
5977713
Docs: Minor fixes in the Vue integration.
gorzelinski May 20, 2024
eb793b7
Docs: Modify the structure of the Next integration.
gorzelinski May 20, 2024
c4321c2
Docs: Add new method to the React integration.
gorzelinski May 20, 2024
40b410d
Docs: Unify the Builder naming.
gorzelinski May 21, 2024
a52ef07
Docs: Remove excessive articles.
gorzelinski May 21, 2024
b17fb7d
Docs: Remove the excessive section from the Angular guide.
gorzelinski May 21, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 40 additions & 0 deletions docs/framework/how-tos.md
Original file line number Diff line number Diff line change
Expand Up @@ -499,3 +499,43 @@ class InternalLink extends Plugin {
}
}
```

## Framework integrations

### The `JavaScript heap out of memory` error

When building the React application for the production using the `yarn build` command, there is a faint chance it may produce an error related to the memory available on the build machine:

```plain
<--- Last few GCs --->

[32550:0x110008000] 42721 ms: Scavenge (reduce) 4061.0 (4069.6) -> 4060.5 (4070.8) MB, 4.3 / 0.0 ms (average mu = 0.358, current mu = 0.374) allocation failure
[32550:0x110008000] 42726 ms: Scavenge (reduce) 4061.2 (4069.8) -> 4060.6 (4071.3) MB, 4.0 / 0.0 ms (average mu = 0.358, current mu = 0.374) allocation failure
[32550:0x110008000] 42730 ms: Scavenge (reduce) 4061.4 (4073.3) -> 4060.9 (4073.3) MB, 3.7 / 0.0 ms (average mu = 0.358, current mu = 0.374) allocation failure

<--- JS stacktrace --->

FATAL ERROR: Ineffective mark-compacts near heap limit Allocation failed - JavaScript heap out of memory
1: 0x1012e4da5 node::Abort() (.cold.1) [/usr/local/bin/node]
```

This issue has not been fixed yet, however, there is a workaround for this. Increasing the available memory for Node.js using the `--max_old_space_size` modifier should resolve the problem.

```bash
node --max_old_space_size=4096 node_modules/.bin/react-scripts build
```

The memory limit can be set globally as well:

```bash
# Save it in the `.bash_profile` file to avoid typing it after rebooting the machine.
export NODE_OPTIONS="--max-old-space-size=4096"

yarn build
```

It can also be set on-demand, per command call:

```bash
NODE_OPTIONS="--max-old-space-size=4096" yarn build
```
Loading