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

[Documentation] Show 3rd party libs with compatible version #2521

Open
1 task done
bitbreakr opened this issue Nov 7, 2022 · 1 comment
Open
1 task done

[Documentation] Show 3rd party libs with compatible version #2521

bitbreakr opened this issue Nov 7, 2022 · 1 comment

Comments

@bitbreakr
Copy link

bitbreakr commented Nov 7, 2022

Is there an existing issue that is already proposing this?

  • I have searched the existing issues

Is your feature request related to a problem? Please describe it

Some companies have difficulty updating to more recent versions because of technical debt.

I have broken the production environment, installing the latest NATS with @nestjs/microservices version 7.5.5, and still don't know which version works with the other.

Describe the solution you'd like

Using @nestjs/microservice with nats, for example, is not problem-free.

For all versions of the documentation, each time a command is displayed to install a dependency that depends on a 3rd party, a select should ask for the exact version of Nest.js and then display the command with the exact version to install

The documentation should, for security measures, show which version of microservice is compatible with which version of clients like Redis, nats, rabbitmq, etc...

Teachability, documentation, adoption, migration strategy

Here below is an example of a switcher (1) and the command to install a package (2)

When the user selects a specific version of Nestjs (1), the command shows the according version of a 3rd party package that will work flawlessly with the microservice package (2)

CleanShot 2022-11-07 at 11 20 24@2x

What is the motivation / use case for changing the behavior?

My motivation is to prevent other developers from having the same issue as Nestjs is a project that evolves fast.

@bitbreakr bitbreakr changed the title Nestjs 7 documentation update [Documentation] Show 3rd party libs with compatible version Nov 7, 2022
@micalevisk
Copy link
Member

yeah, that would help a lot

My only concern is that others snippets and the text itself in the page won't change accordingly, and this might confuse people.

@kamilmysliwiec kamilmysliwiec transferred this issue from nestjs/nest Nov 7, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants