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

nvm: add page #7511

Merged
merged 5 commits into from
Dec 27, 2021
Merged

nvm: add page #7511

merged 5 commits into from
Dec 27, 2021

Conversation

reinhart1010
Copy link
Collaborator

  • The page (if new), does not already exist in the repository.
  • The page is in the correct platform directory (common/, linux/, etc.)
  • The page has 8 or fewer examples.
  • The PR title conforms to the recommended templates.
  • The page follows the content guidelines.
  • The page description includes a link to documentation or a homepage (if applicable).

Version of the command being documented (if known): 1.1.8

This is related to our discussion on #7480

@github-actions github-actions bot added the new command Issues requesting creation of a new page. label Dec 6, 2021
@reinhart1010 reinhart1010 changed the title nvm-windows: Add page windows/nvm: Add page Dec 6, 2021
@tldr-bot
Copy link

tldr-bot commented Dec 6, 2021

Hello! I've noticed something unusual when checking this PR:

  • The page windows/nvm.md seems to be a copy of common/nvm.md (65% matching).

Is this intended? If so, just ignore this comment. Otherwise, please double-check the commits.

@tldr-bot
Copy link

tldr-bot commented Dec 6, 2021

The build for this PR failed with the following error(s):

pages/windows/nvm.md:11: TLDR104 Example descriptions should prefer infinitive tense (e.g. write) over present (e.g. writes) or gerund (e.g. writing)

Please fix the error(s) and push again.

Apparently there's no equivalence of `nvm run` and `nvm exec` in the Windows version.
@navarroaxel navarroaxel changed the title windows/nvm: Add page nvm: add page Dec 6, 2021
Copy link
Member

@einverne einverne left a comment

Choose a reason for hiding this comment

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

nvm page is located in the common directory, you do not need to add it to the windows directory.

@nicokosi nicokosi mentioned this pull request Dec 7, 2021
6 tasks
@reinhart1010
Copy link
Collaborator Author

nvm page is located in the common directory, you do not need to add it to the windows directory.

This is yet another different variant of NVM, since the original program does not run natively on Windows and some commands from the original (e.g. nvm exec) are not supported on this Windows variant.

Copy link
Member

@sbrl sbrl left a comment

Choose a reason for hiding this comment

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

Thanks, @reinhart1010!

Since the original nvm is completely incompatible with the version documented in common/nvm, this is ok @einverne. See #7480

Left an optional comment below.

# nvm

> Install, uninstall or switch between Node.js versions.
> Supports version numbers like "0.12" or "v4.2", and labels like "stable", "system", etc.
Copy link
Member

Choose a reason for hiding this comment

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

0.12 and v4.2 are seriously old anad unsupported versions of Node.js. Could we update these slightly at all please?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Ah I originally copied that from the original tldr-page of nvm. Maybe we should update that too since this Windows version doesn’t support installing very old (io.js) versions.

@sbrl sbrl added the review needed Prioritized PRs marked for reviews from maintainers. label Dec 7, 2021
Copy link
Member

@sbrl sbrl left a comment

Choose a reason for hiding this comment

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

Thanks, @reinhart1010!

pages/windows/nvm.md Outdated Show resolved Hide resolved
Copy link
Member

@einverne einverne left a comment

Choose a reason for hiding this comment

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

Looks like I miss the #7480, thank @sbrl to point out.
And then this page looks good to me.

Copy link
Member

@CleanMachine1 CleanMachine1 left a comment

Choose a reason for hiding this comment

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

Once my singular suggestion above is added then merge!

Co-authored-by: CleanMachine1 <78213164+CleanMachine1@users.noreply.github.com>
@reinhart1010
Copy link
Collaborator Author

Once my singular suggestion above is added then merge!

Done

@CleanMachine1 CleanMachine1 merged commit 59bff1c into tldr-pages:main Dec 27, 2021
@navarroaxel navarroaxel removed the review needed Prioritized PRs marked for reviews from maintainers. label Dec 30, 2021
@reinhart1010 reinhart1010 deleted the nvm-windows branch July 12, 2022 01:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
new command Issues requesting creation of a new page.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants