Skip to content

Commit

Permalink
Use pnpm to manage docusaurus packages (#33922)
Browse files Browse the repository at this point in the history
  • Loading branch information
ambirdsall authored Jan 4, 2024
1 parent 15490f6 commit ab806f9
Show file tree
Hide file tree
Showing 6 changed files with 11,458 additions and 11,148 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@
"**/dbt-project-template-tidb",
"**/dbt-project-template",
"**/node_modules",
"**/pnpm-lock.yaml", # This file is generated and should not be formatted
"**/normalization_test_output",
"**/source-amplitude/unit_tests/api_data/zipped.json", # Zipped file presents as non-UTF-8 making spotless sad
"**/tools/git_hooks/tests/test_spec_linter.py",
Expand Down
8 changes: 4 additions & 4 deletions docs/contributing-to-airbyte/writing-docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,22 +58,22 @@ To make complex changes or edit multiple files, edit the files on your local mac

```bash
cd docusaurus
yarn install
pnpm install
```

To see changes as you make them, run:

```bash
yarn start
pnpm start
```

Then navigate to [http://localhost:3005/](http://localhost:3005/). Whenever you make and save changes, you will see them reflected in the server. You can stop the running server in OSX/Linux by pressing `Ctrl-C` in the terminal.

You can also build the docs locally and see the resulting changes. This is useful if you introduce changes that need to be run at build-time (e.g. adding a docs plug-in). To do so, run:

```bash
yarn build
yarn serve
pnpm build
pnpm serve
```

Then navigate to [http://localhost:3000/](http://localhost:3000/) to see your changes. You can stop the running server in OSX/Linux by pressing `Ctrl-C` in the terminal.
Expand Down
1 change: 1 addition & 0 deletions docusaurus/.nvmrc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
18.15.0
16 changes: 8 additions & 8 deletions docusaurus/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,26 +7,26 @@ changes get merged to `master`.

## Installation

For consistency across other Airbyte projects we use yarn (A Javascript based software package
For consistency across other Airbyte projects we use `pnpm` (A Javascript based software package
manager).

```bash
brew install yarn
brew install pnpm

cd docusaurus
yarn install
yarn build
pnpm install
pnpm build
```

`yarn build` will build Docusaurus site in `docusaurus/build` directory.
`pnpm build` will build Docusaurus site in `docusaurus/build` directory.

## Developing Locally

If you want to make changes to the documentation, you can run docusaurus locally in a way that would
listen to any source docs changes and live-reload them:

```bash
yarn start # any changes will automatically be reflected in your browser!
pnpm start # any changes will automatically be reflected in your browser!
```

All the content for docs.airbyte.com lives in the `/docs` directory in this repo. All files are
Expand All @@ -41,7 +41,7 @@ in [`sidebars.js`](https://github.com/airbytehq/airbyte/blob/master/docusaurus/s

We welcome documentation updates! If you'd like to contribute a change, please make sure to:

- Run `yarn build` and check that all build steps are successful.
- Run `pnpm build` and check that all build steps are successful.
- Push your changes into a pull request, and follow the PR template instructions.

When you make a pull request, Vercel will automatically build a test instance of the full docs site
Expand All @@ -61,7 +61,7 @@ periodically:
> fine. For that reason, if you're linking to another Airbyte documentation page, make it a relative
> link. I.e. `[link](/connector-development/overview.md)` instead of
> `[link](https://docs.airbyte.com/connector-development/)`. That way, if your link breaks in the
> future due to a navigation restructure, it will be caught with `yarn build`.
> future due to a navigation restructure, it will be caught with `pnpm build`.
## Docusaurus Plugins We Use

Expand Down
Loading

0 comments on commit ab806f9

Please sign in to comment.