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

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

Merged
merged 2 commits into from
May 9, 2024

Conversation

klm-turing
Copy link
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 owner May 9, 2024 16:52
@klm-turing
Copy link
Contributor Author

@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-turing klm-turing changed the title fix: npm help json/global command on windows docs: npm help json/global command on windows May 9, 2024
@lukekarrys lukekarrys self-assigned this May 9, 2024
docs/lib/content/nav.yml Outdated Show resolved Hide resolved
@lukekarrys
Copy link
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
Contributor Author

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

@lukekarrys lukekarrys merged commit c3d2819 into npm:latest May 9, 2024
7 checks passed
@github-actions github-actions bot 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
Contributor

mbtools commented May 10, 2024

thanks @klm-turing 👍

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.

[BUG] npm help json errors on Windows
3 participants