Skip to content

feat: new CLI documentation - #4051

Merged
sokra merged 13 commits into
webpack:masterfrom
anshumanv:cli-docs
Oct 14, 2020
Merged

sokra merged 13 commits into
webpack:masterfrom
anshumanv:cli-docs

Conversation

@anshumanv

@anshumanv anshumanv commented Oct 9, 2020 •

Copy link
Copy Markdown
Contributor

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

vercel Bot commented Oct 9, 2020 •

Copy link
Copy Markdown

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

@snitin315 snitin315 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Comment thread src/content/api/cli.md Resolved
Comment thread src/content/api/cli.md Resolved
Comment thread src/content/api/cli.md Resolved
Comment thread src/content/api/cli.md Resolved
Comment thread src/content/api/cli.md Resolved

@alexander-akait alexander-akait left a comment

Copy link
Copy Markdown
Member

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)?

@rishabh3112 rishabh3112 left a comment

Copy link
Copy Markdown
Contributor

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.

Comment thread src/content/api/cli.md Resolved
Comment thread src/content/api/cli.md Resolved
Comment thread src/content/api/cli.md Resolved
Comment thread src/content/api/cli.md Resolved
Comment thread src/content/api/cli.md Resolved
Comment thread src/content/api/cli.md Resolved
Comment thread src/content/api/cli.md Resolved
@anshumanv anshumanv changed the title feat[wip]: new CLI documentation feat: new CLI documentation Oct 10, 2020
Comment thread src/content/api/cli.md Resolved
@snitin315

Copy link
Copy Markdown
Contributor

Great work @anshumanv 🎉

@alexander-akait

Copy link
Copy Markdown
Member

@anshumanv Can you rebase?

@anshumanv

Copy link
Copy Markdown
Contributor Author

Done @evilebottnawi

@anshumanv

Copy link
Copy Markdown
Contributor Author

@webpack/cli-team all good?

@jamesgeorge007 jamesgeorge007 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Left a suggestion.

Comment thread src/content/api/cli.md Resolved
@snitin315

Copy link
Copy Markdown
Contributor

@webpack/cli-team all good?

#4051 (comment)

Comment thread src/content/api/cli.md Resolved
Comment thread src/content/api/cli.md Resolved

@alexander-akait alexander-akait left a comment

Copy link
Copy Markdown
Member

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
Copy Markdown
Contributor Author

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

/cc @evilebottnawi

Comment thread src/content/api/cli.md Resolved
Comment thread src/content/api/cli.md Resolved
Comment thread src/content/api/cli.md Resolved
Comment thread src/content/api/cli.md Resolved
@sokra

sokra commented Oct 14, 2020 •

Copy link
Copy Markdown
Member

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
Copy Markdown
Contributor 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
Copy Markdown
Contributor Author

API rate limit on Travis

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

sokra commented Oct 14, 2020

Copy link
Copy Markdown
Member

Thanks

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

lgodziejewski commented Jan 28, 2021 •

Copy link
Copy Markdown

@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
Copy Markdown
Contributor Author

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

This branch was successfully deployed

1 active deployment
Preview — d60a35e0 Deployed Oct 14, 2020 by vercel[bot]
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