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

Document installing plugin@next #3756

Closed
Morriz opened this issue Nov 15, 2020 · 4 comments · Fixed by #3783
Closed

Document installing plugin@next #3756

Morriz opened this issue Nov 15, 2020 · 4 comments · Fixed by #3783
Labels
documentation The issue is related to the documentation of Docusaurus

Comments

@Morriz
Copy link

Morriz commented Nov 15, 2020

📚 Documentation

It took me some time to figure out that installing a plugin as documented was giving me errors (See #3755 ) because the version would not match core. Example:

npm install -S @docusaurus/plugin-ideal-image

This would install the latest published version of the plugin, which was 2.0.0-alpha.37 at the time of writing.

It turns out that installing a plugin @next somehow does install it at core version, which I did not see documented here: https://v2.docusaurus.io/docs/using-plugins/

Example:

npm install -S @docusaurus/plugin-ideal-image@next

After doing that I see version 2.0.0-alpha.66 of the plugin installed (which is strange as it is not published).

Have you read the Contributing Guidelines on issues?

Yes

@Morriz Morriz added documentation The issue is related to the documentation of Docusaurus status: needs triage This issue has not been triaged by maintainers labels Nov 15, 2020
@slorber
Copy link
Collaborator

slorber commented Nov 16, 2020

We indeed want to align versions, the error is on-purpose fail-fast behavior to avoid more nasty issues due to incompatible versions.

According to you, what changes should be made to the docs to make this clearer?
Would you mind submitting a PR doing this update?

Alpha 66 version is published under the "next" tag.

https://www.npmjs.com/package/@docusaurus/plugin-ideal-image

@slorber slorber removed the status: needs triage This issue has not been triaged by maintainers label Nov 16, 2020
@Morriz
Copy link
Author

Morriz commented Nov 17, 2020

"NOTICE: To circumvent npm errors due to incompatible versions installed between core and plugins, we advise to install all packages at version "next". Example:

npm install -S @docusaurus/core@next @docusaurus/plugin-ideal-image@next"

Maybe something like this?

@slorber
Copy link
Collaborator

slorber commented Nov 18, 2020 via email

@slorber
Copy link
Collaborator

slorber commented Nov 19, 2020

It looks like it work as expected now, you don't need the next tag anymore to get latest packages

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation The issue is related to the documentation of Docusaurus
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants