Using NPM vs Yarn to build docs #988
Assignees
Labels
area/documentation
Improvements or additions to documentation
scope/S
Change is Small
type/fix
Fixes something
Comments
kamilprz
added
area/documentation
|
Agree that having both is a problem, but I'm surprised at the suggestion. I thought Yarn was better for many reasons (reproducibility, speed). |
|
The main reason for deleting Yarn docs is that it seems the repo is already set on using NPM. This can be seen in the Makefile under Based on that it seems that the Yarn docs are just a remnant of the past. |
7 tasks
github-merge-queue bot
pushed a commit
that referenced
this issue
Nov 26, 2024
# Description Removing mention of Yarn from building docs, since npm is used instead. ## Related Issue #988 ## Checklist - [x] I have read the [contributing documentation](https://retina.sh/docs/contributing). - [x] I signed and signed-off the commits (`git commit -S -s ...`). See [this documentation](https://docs.github.com/en/authentication/managing-commit-signature-verification/about-commit-signature-verification) on signing commits. - [x] I have correctly attributed the author(s) of the code. - [x] I have tested the changes locally. - [x] I have followed the project's style guidelines. - [x] I have updated the documentation, if necessary. - [ ] I have added tests, if applicable. --- Please refer to the [CONTRIBUTING.md](../CONTRIBUTING.md) file for more information on how to contribute to this project. --------- Signed-off-by: Kamil <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Within
site/README.mdit is mentioned to use Yarn for building docs locally, however, the make file uses npm.In the project we have a
package-lock.jsonwhich indicates that this project uses npm and ensures consistent installs across different environments. Yarn usesyarn.lockinstead. 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.
The text was updated successfully, but these errors were encountered: