Skip to content

Commit 27902a0

Browse files
committed
chore: mention yarn in contributing.md
1 parent 50665c2 commit 27902a0

File tree

2 files changed

+24
-19
lines changed

2 files changed

+24
-19
lines changed

.github/workflows/lychee.yml

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,18 +15,23 @@ jobs:
1515
uses: actions/setup-node@v4
1616
with:
1717
node-version: 22
18-
cache: 'npm'
19-
cache-dependency-path: 'package-lock.json'
2018
always-auth: 'true'
2119

2220
- name: Enable corepack
2321
run: |
2422
corepack enable
23+
corepack prepare yarn@stable --activate
24+
25+
- name: Activate cache for Node.js
26+
uses: actions/setup-node@v4
27+
with:
28+
cache: yarn
29+
cache-dependency-path: yarn.lock
2530

2631
- name: Build docs
2732
run: |
28-
npm ci --force
29-
npm run build
33+
yarn --immutable
34+
yarn build
3035
env:
3136
APIFY_SIGNING_TOKEN: ${{ secrets.APIFY_SIGNING_TOKEN }}
3237
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

CONTRIBUTING.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -18,17 +18,17 @@
1818

1919
<!-- vale off -->
2020
1. Clone the repository
21-
2. Run `npm install`
22-
3. Start development server: `npm start`
21+
2. Run `yarn`
22+
3. Start development server: `yarn start`
2323
<!-- vale on -->
2424

2525
This will be enough to work on Platform, Academy and OpenAPI. If you want to work on the entire documentation set, you need to join them using nginx.
2626

2727
#### Join all repositories with nginx
2828

2929
1. Clone all the repositories
30-
2. Run `npm start:dev` instead of `npm start` from the main repository
31-
3. Run `npm start -- --port <number>` to start Docusaurus instance on specific port, refer to the table for each repository port
30+
2. Run `yarn start:dev` instead of `yarn start` from the main repository
31+
3. Run `yarn start -- --port <number>` to start Docusaurus instance on specific port, refer to the table for each repository port
3232

3333
|Repository|Port|
3434
|:---|:---|
@@ -155,12 +155,12 @@ The API reference documentation at [docs.apify.com](https://docs.apify.com/) is
155155
156156
1. Install Node.js
157157
2. Clone the repository
158-
3. Run `npm install`
158+
3. Run `yarn`
159159
160160
### Basic commands
161161
162-
- `npm start` - Starts docs preview server including API reference
163-
- `npm test` - Validates the definition
162+
- `yarn start` - Starts docs preview server including API reference
163+
- `yarn test` - Validates the definition
164164
165165
### Adding new documentation
166166
@@ -246,7 +246,7 @@ Add languages by adding new folders at the appropriate path level.
246246
#### Submitting changes
247247

248248
1. Make your changes following the guidelines above
249-
2. Test locally using provided npm commands
249+
2. Test locally using provided `yarn` commands
250250
3. Submit a pull request to the `main` branch
251251
4. Ensure all CI checks pass
252252

@@ -258,8 +258,8 @@ Add languages by adding new folders at the appropriate path level.
258258

259259
```bash
260260
261-
npm install
262-
npm start
261+
yarn
262+
yarn start
263263
264264
```
265265

@@ -268,7 +268,7 @@ Add languages by adding new folders at the appropriate path level.
268268
- Clone all documentation repositories
269269
- Configure nginx server
270270
- Update hosts file
271-
- Use `npm start:dev`
271+
- Use `yarn start:dev`
272272

273273
## Quality check
274274

@@ -277,15 +277,15 @@ Add languages by adding new folders at the appropriate path level.
277277
1. Markdown:
278278

279279
```bash
280-
npm run lint:md # Checks for any issues using markdownlint
281-
npm run lint:md:fix # Applies fixes
280+
yarn lint:md # Checks for any issues using markdownlint
281+
yarn lint:md:fix # Applies fixes
282282
```
283283

284284
2. Code:
285285

286286
```bash
287-
npm run lint:code # Checks .js & .ts files
288-
npm run lint:code:fix # Applies fixes
287+
yarn lint:code # Checks .js & .ts files
288+
yarn lint:code:fix # Applies fixes
289289
```
290290

291291
3. Prose:

0 commit comments

Comments
 (0)