Skip to content

Commit 8001098

Browse files
ejarocki-cloudlinuxejarocki-cloudlinux
authored
Merge pull request #377 from ejarocki-cloudlinux/master
Update JS docs with the new deps installation approach
2 parents e653125 + 7ecff4b commit 8001098

36 files changed

Lines changed: 1227 additions & 2222 deletions

File tree

‎docs/els-for-libraries/angular/README.md‎

Lines changed: 453 additions & 481 deletions
Large diffs are not rendered by default.

‎docs/els-for-libraries/angularjs/README.md‎

Lines changed: 40 additions & 68 deletions
Original file line numberDiff line numberDiff line change
@@ -49,39 +49,7 @@ TuxCare provides ELS for AngularJS as an NPM package, hosted on a secure interna
4949

5050
4. Replace your AngularJS dependencies with TuxCare ones. You can use one of the following methods:
5151

52-
* **Option 1: TuxCare Patcher (Automated)**
53-
54-
Install the Patcher globally and run the following commands. The TuxCare Patcher automatically detects the AngularJS version in your `package.json` and updates your `dependencies` and `overrides` to use the corresponding TuxCare `@els-js/*` packages.
55-
56-
<CodeWithCopy>
57-
58-
```text
59-
npm install -g @els-js/tuxcare-patcher --userconfig ./.npmrc
60-
tuxcare-patch-js
61-
```
62-
63-
</CodeWithCopy>
64-
65-
The patcher will update your `package.json`, for example, from:
66-
67-
```text
68-
"dependencies": {
69-
"angular": "^1.8.3"
70-
}
71-
```
72-
73-
to:
74-
75-
```text
76-
"dependencies": {
77-
"angular": "npm:@els-js/angular@1.8.3-tuxcare.4"
78-
},
79-
"overrides": {
80-
"angular@1.8.3": "npm:@els-js/angular@1.8.3-tuxcare.4"
81-
}
82-
```
83-
84-
* **Option 2: Manual Update**
52+
* **Option 1: Manual update**
8553

8654
Manually update your `package.json` file by replacing your AngularJS dependencies with the TuxCare packages. This method gives you full control over which packages to update.
8755

@@ -93,7 +61,7 @@ TuxCare provides ELS for AngularJS as an NPM package, hosted on a secure interna
9361

9462
```text
9563
"dependencies": {
96-
"angular": "npm:@els-js/angular@1.4.4-tuxcare.1"
64+
"angular": "npm:@els-js/angular@>=1.4.4-tuxcare.1"
9765
}
9866
```
9967
@@ -107,7 +75,7 @@ TuxCare provides ELS for AngularJS as an NPM package, hosted on a secure interna
10775
10876
```text
10977
"dependencies": {
110-
"angular": "npm:@els-js/angular@1.5.11-tuxcare.6"
78+
"angular": "npm:@els-js/angular@>=1.5.11-tuxcare.1"
11179
}
11280
```
11381
@@ -121,7 +89,7 @@ TuxCare provides ELS for AngularJS as an NPM package, hosted on a secure interna
12189
12290
```text
12391
"dependencies": {
124-
"angular": "npm:@els-js/angular@1.6.10-tuxcare.6"
92+
"angular": "npm:@els-js/angular@>=1.6.10-tuxcare.1"
12593
}
12694
```
12795
@@ -135,7 +103,7 @@ TuxCare provides ELS for AngularJS as an NPM package, hosted on a secure interna
135103
136104
```text
137105
"dependencies": {
138-
"angular": "npm:@els-js/angular@1.7.9-tuxcare.5"
106+
"angular": "npm:@els-js/angular@>=1.7.9-tuxcare.1"
139107
}
140108
```
141109
@@ -149,7 +117,7 @@ TuxCare provides ELS for AngularJS as an NPM package, hosted on a secure interna
149117
150118
```text
151119
"dependencies": {
152-
"angular": "npm:@els-js/angular@1.8.2-tuxcare.5"
120+
"angular": "npm:@els-js/angular@>=1.8.2-tuxcare.1"
153121
}
154122
```
155123
@@ -163,7 +131,7 @@ TuxCare provides ELS for AngularJS as an NPM package, hosted on a secure interna
163131
164132
```text
165133
"dependencies": {
166-
"angular": "npm:@els-js/angular@1.8.3-tuxcare.6"
134+
"angular": "npm:@els-js/angular@>=1.8.3-tuxcare.1"
167135
}
168136
```
169137
@@ -173,6 +141,38 @@ TuxCare provides ELS for AngularJS as an NPM package, hosted on a secure interna
173141
174142
</TableTabs>
175143
144+
* **Option 2: TuxCare Patcher (Automated)**
145+
146+
Install the Patcher globally and run the following commands. The TuxCare Patcher automatically detects the AngularJS version in your `package.json` and updates your `dependencies` and `overrides` to use the corresponding TuxCare `@els-js/*` packages.
147+
148+
<CodeWithCopy>
149+
150+
```text
151+
npm install -g @els-js/tuxcare-patcher --userconfig ./.npmrc
152+
tuxcare-patch-js
153+
```
154+
155+
</CodeWithCopy>
156+
157+
The patcher will update your `package.json`, for example, from:
158+
159+
```text
160+
"dependencies": {
161+
"angular": "^1.8.3"
162+
}
163+
```
164+
165+
to:
166+
167+
```text
168+
"dependencies": {
169+
"angular": "npm:@els-js/angular@>=1.8.3-tuxcare.1"
170+
},
171+
"overrides": {
172+
"angular@1.8.3": "npm:@els-js/angular@>=1.8.3-tuxcare.1"
173+
}
174+
```
175+
176176
5. You need to remove the `node_modules` directory and the `package-lock.json` file, and also clear the `npm cache` before installing the patched packages. Use the following commands:
177177
178178
<CodeWithCopy>
@@ -217,35 +217,7 @@ TuxCare provides VEX for AngularJS ELS versions: [security.tuxcare.com/vex/cyclo
217217

218218
## How to Upgrade to a Newer Version of TuxCare Packages
219219

220-
If you have already installed a package with a `tuxcare.1` suffix and want to upgrade to a newer release (for example, `tuxcare.4`), you can use one of the following methods:
221-
222-
* **Option 1: TuxCare Patcher (Automated). Recommended for projects with multiple TuxCare dependencies.**
223-
224-
The TuxCare Patcher automatically detects all TuxCare dependencies in your `package.json` and updates them to the latest available versions.
225-
226-
<CodeWithCopy>
227-
228-
```text
229-
tuxcare-patch-js --upgrade
230-
```
231-
232-
</CodeWithCopy>
233-
234-
* **Option 2: Manual Update via CLI (Single Dependency)**
235-
236-
If you want to update a single TuxCare dependency, use the npm install command with the specific version. This automatically updates both `package.json` and `package-lock.json`:
237-
238-
<CodeWithCopy>
239-
240-
```text
241-
npm install angular@npm:@els-js/angular@1.8.3-tuxcare.4
242-
```
243-
244-
</CodeWithCopy>
245-
246-
* **Option 3: Manual Update via package.json (Multiple Dependencies)**
247-
248-
If you want to update several TuxCare dependencies, manually update the version strings in your `package.json`, then remove installed files and clear npm cache to avoid conflicts:
220+
If you have already installed a package with a `tuxcare.1` suffix and want to upgrade to a newer release (for example, `tuxcare.3`), remove node_modules, clear the npm cache to avoid conflicts, and then run the installation command:
249221

250222
<CodeWithCopy>
251223

‎docs/els-for-libraries/bootstrap-sass/README.md‎

Lines changed: 18 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,21 @@ TuxCare provides ELS for bootstrap-sass as an NPM package, hosted on a secure in
4949

5050
4. Update your `package.json` file to replace your bootstrap-sass dependencies with the TuxCare packages. You can do this in two ways:
5151

52-
* **Option 1: TuxCare Patcher (Automated)**
52+
* **Option 1: Manual update**
53+
54+
Manually update your `package.json` file by replacing your bootstrap-sass dependencies with the TuxCare packages. This method gives you full control over which packages to update.
55+
56+
<CodeWithCopy>
57+
58+
```text
59+
"dependencies": {
60+
"bootstrap-sass": "npm:@els-js/bootstrap-sass@>=3.4.0-tuxcare.1"
61+
}
62+
```
63+
64+
</CodeWithCopy>
65+
66+
* **Option 2: TuxCare Patcher (Automated)**
5367
5468
Install the Patcher globally and run it. The TuxCare Patcher automatically detects the bootstrap-sass version in your `package.json` and updates your `dependencies` and `overrides` to use the corresponding TuxCare `@els-js/*` packages.
5569
@@ -74,26 +88,12 @@ TuxCare provides ELS for bootstrap-sass as an NPM package, hosted on a secure in
7488
7589
```text
7690
"dependencies": {
77-
"bootstrap-sass": "npm:@els-js/bootstrap-sass@3.4.0-tuxcare.1"
91+
"bootstrap-sass": "npm:@els-js/bootstrap-sass@>=3.4.0-tuxcare.1"
7892
},
7993
"overrides": {
80-
"bootstrap-sass@3.4.0": "npm:@els-js/bootstrap-sass@3.4.0-tuxcare.1"
94+
"bootstrap-sass@3.4.0": "npm:@els-js/bootstrap-sass@>=3.4.0-tuxcare.1"
8195
}
8296
```
83-
84-
* **Option 2: Manual Update**
85-
86-
Manually update your `package.json` file by replacing your bootstrap-sass dependencies with the TuxCare packages. This method gives you full control over which packages to update.
87-
88-
<CodeWithCopy>
89-
90-
```text
91-
"dependencies": {
92-
"bootstrap-sass": "npm:@els-js/bootstrap-sass@3.4.0-tuxcare.1"
93-
}
94-
```
95-
96-
</CodeWithCopy>
9797
9898
5. You need to remove the `node_modules` directory and the `package-lock.json` file, and also clear the `npm cache` before installing the patched packages. Use the following commands:
9999
@@ -139,35 +139,7 @@ TuxCare provides VEX for bootstrap-sass ELS versions: [security.tuxcare.com/vex/
139139

140140
## How to Upgrade to a Newer Version of TuxCare Packages
141141

142-
If you have already installed a package with a `tuxcare.1` suffix and want to upgrade to a newer release (for example, `tuxcare.3`), you can use one of the following methods:
143-
144-
* **Option 1: TuxCare Patcher (Automated). Recommended for projects with multiple TuxCare dependencies.**
145-
146-
The TuxCare Patcher automatically detects all TuxCare dependencies in your `package.json` and updates them to the latest available versions.
147-
148-
<CodeWithCopy>
149-
150-
```text
151-
tuxcare-patch-js --upgrade
152-
```
153-
154-
</CodeWithCopy>
155-
156-
* **Option 2: Manual Update via CLI (Single Dependency)**
157-
158-
If you want to update a single TuxCare dependency, use the npm install command with the specific version. This automatically updates both `package.json` and `package-lock.json`:
159-
160-
<CodeWithCopy>
161-
162-
```text
163-
npm install bootstrap-sass@npm:@els-js/bootstrap-sass@3.4.0-tuxcare.1
164-
```
165-
166-
</CodeWithCopy>
167-
168-
* **Option 3: Manual Update via package.json (Multiple Dependencies)**
169-
170-
If you want to update several TuxCare dependencies, manually update the version strings in your `package.json`, then remove installed files and clear npm cache to avoid conflicts:
142+
If you have already installed a package with a `tuxcare.1` suffix and want to upgrade to a newer release (for example, `tuxcare.3`), remove node_modules, clear the npm cache to avoid conflicts, and then run the installation command:
171143

172144
<CodeWithCopy>
173145

0 commit comments

Comments
 (0)