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

Reduce gem size and remove yarn install warning when building docs site #1297

Merged
merged 2 commits into from
Apr 6, 2022

Conversation

deivid-rodriguez
Copy link
Contributor

The biggest file in our gem package is docs/package-lock.json but I don't think it's needed since the documentation site uses yarn.

Removing it should reduce the gem package size.

It also fixes the following yarn install warning:

➜  docs git:(main) yarn install
yarn install v1.22.18
warning package-lock.json found. Your project contains lock files generated by tools other than Yarn. It is advised not to mix package managers in order to avoid resolution inconsistencies caused by unsynchronized lock files. To clear this warning, remove package-lock.json.
[1/4] 🔍  Resolving packages...
(...)

Yarn is used for local development.
`yarn install` is necessary to install docusaurus.
@deivid-rodriguez deivid-rodriguez changed the title Reduce gem size and remove yarn install warning in docs size Reduce gem size and remove yarn install warning when building docs site Apr 1, 2022
@scarroll32 scarroll32 self-requested a review April 1, 2022 09:36
Copy link
Member

@scarroll32 scarroll32 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good to me @deivid-rodriguez, we will need to manually deploy the docs site afterwards.

I have opened #1298 to make that an automatic process.

@scarroll32
Copy link
Member

scarroll32 commented Apr 1, 2022

@deivid-rodriguez the code looks fine but I don't have time to manage the site build right now, so I will merge this tonight or tomorrow.

@deivid-rodriguez
Copy link
Contributor Author

Thanks @scarroll32, yeah, we should definitely deploy automatically.

@scarroll32 scarroll32 merged commit a7b2c27 into main Apr 6, 2022
@scarroll32 scarroll32 deleted the tweak-docs branch April 6, 2022 19:05
@scarroll32
Copy link
Member

Thanks @deivid-rodriguez

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants