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

Using NPM vs Yarn to build docs #988

Open
kamilprz opened this issue Nov 11, 2024 · 1 comment
Open

Using NPM vs Yarn to build docs #988

kamilprz opened this issue Nov 11, 2024 · 1 comment
Assignees
Labels
area/documentation Improvements or additions to documentation scope/S Change is Small type/fix Fixes something

Comments

@kamilprz
Copy link
Contributor

Within site/README.md it is mentioned to use Yarn for building docs locally, however, the make file uses npm.

In the project we have a package-lock.json which indicates that this project uses npm and ensures consistent installs across different environments. Yarn uses yarn.lock instead. Using both locks can lead to conflicts if they are out-of-sync.

We should remain consistent. Suggested change would be to remove the Yarn documentation.

@kamilprz kamilprz added area/documentation Improvements or additions to documentation scope/S Change is Small type/fix Fixes something labels Nov 11, 2024
@kamilprz kamilprz self-assigned this Nov 11, 2024
@timraymond
Copy link
Member

Agree that having both is a problem, but I'm surprised at the suggestion. I thought Yarn was better for many reasons (reproducibility, speed).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation Improvements or additions to documentation scope/S Change is Small type/fix Fixes something
Projects
Status: No status
Development

No branches or pull requests

2 participants