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

feat: new CLI documentation #4051

Merged
merged 13 commits into from Oct 14, 2020
Merged

feat: new CLI documentation #4051

merged 13 commits into from Oct 14, 2020

Conversation

anshumanv
Copy link
Member

@anshumanv anshumanv commented Oct 9, 2020

Documentation for new CLI

Fixes #4030

  • Read and sign the CLA. PRs that haven't signed it won't be accepted.
  • Make sure your PR complies with the writer's guide.
  • Review the diff carefully as sometimes this can reveal issues.
  • Do not abandon your Pull Request: Stale Pull Requests.

/cc @webpack/cli-team would be great if you can start reviewing ⭐

@vercel
Copy link

vercel bot commented Oct 9, 2020

This pull request is being automatically deployed with Vercel (learn more).
To see the status of your deployment, click below or on the icon next to each commit.

🔍 Inspect: https://vercel.com/webpack-docs/webpack-js-org/k2pojpqtt
✅ Preview: https://webpack-js-org-git-cli-docs.webpack-docs.vercel.app

Copy link
Member

@snitin315 snitin315 left a comment

Choose a reason for hiding this comment

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

Looks Good. Added a few comments.

I think we need to add this link somewhere as appropriate -> https://github.com/webpack/webpack-cli/tree/next/packages/webpack-cli#supported-arguments-and-commands

src/content/api/cli.md Show resolved Hide resolved
src/content/api/cli.md Show resolved Hide resolved
src/content/api/cli.md Show resolved Hide resolved
src/content/api/cli.md Outdated Show resolved Hide resolved
src/content/api/cli.md Outdated Show resolved Hide resolved
Copy link
Member

@alexander-akait alexander-akait left a comment

Choose a reason for hiding this comment

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

Can we give link here on full list of options (webpack@5)?

Copy link
Member

@rishabh3112 rishabh3112 left a comment

Choose a reason for hiding this comment

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

Nice start.
Left some more suggestions, also few flags are not here from webpack 5, we need too add them some how.

src/content/api/cli.md Outdated Show resolved Hide resolved
src/content/api/cli.md Outdated Show resolved Hide resolved
src/content/api/cli.md Outdated Show resolved Hide resolved
src/content/api/cli.md Show resolved Hide resolved
src/content/api/cli.md Outdated Show resolved Hide resolved
src/content/api/cli.md Outdated Show resolved Hide resolved
@anshumanv anshumanv changed the title feat[wip]: new CLI documentation feat: new CLI documentation Oct 10, 2020
src/content/api/cli.md Outdated Show resolved Hide resolved
@snitin315
Copy link
Member

Great work @anshumanv 🎉

@alexander-akait
Copy link
Member

@anshumanv Can you rebase?

@anshumanv
Copy link
Member Author

Done @evilebottnawi

@anshumanv
Copy link
Member Author

@webpack/cli-team all good?

Copy link
Member

@jamesgeorge007 jamesgeorge007 left a comment

Choose a reason for hiding this comment

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

Left a suggestion.

@snitin315
Copy link
Member

@webpack/cli-team all good?

#4051 (comment)

Copy link
Member

@alexander-akait alexander-akait left a comment

Choose a reason for hiding this comment

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

Big thanks!

@anshumanv
Copy link
Member Author

@EugeneHlushko @montogeek can you folks also review? We're getting a bunch of issues about stale docs.

/cc @evilebottnawi

src/content/api/cli.md Outdated Show resolved Hide resolved
src/content/api/cli.md Outdated Show resolved Hide resolved
src/content/api/cli.md Outdated Show resolved Hide resolved
src/content/api/cli.md Show resolved Hide resolved
@sokra
Copy link
Member

sokra commented Oct 14, 2020

I merge it so we have at least some content, but the page probably need an improvement afterwards, e. g. output stats are outdated (webpack 4)

@anshumanv
Copy link
Member Author

I merge it so we have at least some content, but the page probably need an improvement afterwards, e. g. output stats are outdated (webpack 4)

Updated the output stats, we'll still need little updates after some ongoing enhancements though but this should at least give users some understanding about the current behaviour.

@anshumanv anshumanv requested a review from sokra October 14, 2020 12:33
@anshumanv
Copy link
Member Author

API rate limit on Travis

@sokra sokra merged commit c5aa30e into webpack:master Oct 14, 2020
@sokra
Copy link
Member

sokra commented Oct 14, 2020

Thanks

@anshumanv anshumanv deleted the cli-docs branch October 14, 2020 12:54
@montogeek montogeek added the API label Oct 14, 2020
@lgodziejewski
Copy link

lgodziejewski commented Jan 28, 2021

@anshumanv thanks for the changes!

I think they should also be ported to the webpack-4 branch (if that's the one v4 docs are built from 😛), as currently the v4 docs are outdated

@anshumanv
Copy link
Member Author

Yes that's correct @lgodziejewski, will PR to v4 branch in a while

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

CLI: Update docs to v4
8 participants