Skip to content

docs: npm help json/global command on windows - #7496

Merged
lukekarrys merged 2 commits into
npm:latestfrom
klm-turing:docs-npm-help-json-windows
May 9, 2024
Merged

docs: npm help json/global command on windows#7496
lukekarrys merged 2 commits into
npm:latestfrom
klm-turing:docs-npm-help-json-windows

Conversation

@klm-turing

Copy link
Copy Markdown
Contributor

On Windows, npm help json and npm help global attempt to display npm-json.html and npm-global.html files which leads to an error because these files have not been generated.

This pull request duplicates the package-json.md and folders.md files in order to generate these files and make the above-mentioned commands functional.

References

Closes: #7374

@klm-turing
klm-turing requested a review from a team as a code ownerMay 9, 2024 16:52
@klm-turing

Copy link
Copy Markdown
ContributorAuthor

@wraithgar I had to update nav.yml file in order to pass check-nav.js test since I've also duplicated md files. Let me know if it is OK. Thank you

@klm-turingklm-turing changed the title fix: npm help json/global command on windowsdocs: npm help json/global command on windowsMay 9, 2024
@lukekarryslukekarrys self-assigned this May 9, 2024
Comment threaddocs/lib/content/nav.yml Outdated
@lukekarrys

Copy link
Copy Markdown
Contributor

Thanks for your work on this! I had to double-check but we don't actually want to add the aliases for the markdown docs. The markdown files are used in https://github.com/npm/documentation and get their own html redirects in that repo. It's not ideal to have these separate but there are many more html redirects in order to prevent breaking old urls, and those will never apply to the man or html pages (which are just used as a man page replacement on Windows).

@klm-turing

Copy link
Copy Markdown
ContributorAuthor

You are welcome @lukekarrys. Thanks for your inputs and comments.

@lukekarrys
lukekarrysforce-pushed the docs-npm-help-json-windows branch from a917f40 to cc951b7CompareMay 9, 2024 22:17
@lukekarrys
lukekarrys merged commit c3d2819 into npm:latestMay 9, 2024
@github-actionsgithub-actionsBot mentioned this pull request May 9, 2024
@klm-turing
klm-turing deleted the docs-npm-help-json-windows branch May 9, 2024 22:21
@mbtools

Copy link
Copy Markdown
Contributor

thanks @klm-turing 👍

Sign up for freeto 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.

[BUG] npm help json errors on Windows

3 participants

@klm-turing@lukekarrys@mbtools