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]: Update README and Contributing guidelines #247

Closed
2 of 7 tasks
fokusferit opened this issue Jan 21, 2018 · 26 comments
Closed
2 of 7 tasks

[Docs]: Update README and Contributing guidelines #247

fokusferit opened this issue Jan 21, 2018 · 26 comments

Comments

@fokusferit
Copy link
Contributor

fokusferit commented Jan 21, 2018

Updated list of things I will cover:

  • Migrate documentation
  • CLI descriptions at webpack.js.org and in the CLI should be more descriptive
  • README in all the package folders for each package
  • InIt documentation at webpack.js.org
  • Documentation and Contribution guide
  • Explaination about publishing and the next/develop branch
  • Explain empty params code style
@fokusferit fokusferit self-assigned this Jan 21, 2018
@fokusferit fokusferit added this to the Improve Documentation milestone Jan 21, 2018
@evenstensberg
Copy link
Member

evenstensberg commented Jan 22, 2018

For the contribution guides, it should be split into sections like: do you want to make an easy contribution or an advanced one. At the start, we could have a small summary, and maybe split it up into a menu with pointers to different guides. One could be tests, another AST et.al

@dhruvdutt
Copy link
Member

dhruvdutt commented Mar 11, 2018

@ev1stensberg Can we add "help wanted", "Good First Contribution" tags?

@evenstensberg
Copy link
Member

This is an maintainer issue, cause we need to make sure that the structure and documentation reflects how we want people to contribute. Discussed this in a meeting, @fokusferit can give you the link

@evenstensberg
Copy link
Member

@fokusferit any update? 💯

@evenstensberg evenstensberg changed the title Update README and Contributing guidelines Docs: Update README and Contributing guidelines May 18, 2018
@evenstensberg
Copy link
Member

Moving #450 here

@evenstensberg
Copy link
Member

So here's what needs attention:

  1. Migrate documentation

  2. InIt documentation at webpack.js.org

  3. CLI descriptions at webpack.js.org and in the CLI should be more descriptive

  4. README in all the package folders for each package

  5. Documentation and Contribution guide

  6. Explaination about publishing and the next/develop branch

@fokusferit
Copy link
Contributor Author

I'm updating the initial comment, and create a checklist, so that I it's easier to reference to PR's for each task.

@rishabh3112
Copy link
Member

@ev1stensberg I would like to work on Init documentation first.

@evenstensberg
Copy link
Member

Go for it!

@rishabh3112
Copy link
Member

@ev1stensberg check #547 for init documentation

@rishabh3112
Copy link
Member

@ev1stensberg how to add documentation to webpack.js.org to complete this task

@evenstensberg
Copy link
Member

Any update here lads?

@evenstensberg
Copy link
Member

@ematipico @fokusferit it would be really nice if you guys dedicated some time to work on this! ❤️

@fokusferit
Copy link
Contributor Author

THis weekend I have planned to focus! It's scheduled!

@evenstensberg
Copy link
Member

Hmu if you need help @fokusferit

@rishabh3112
Copy link
Member

@ev1stensberg having a documentation website is much better as it will serve the cause quicker.
If you agree to same I am happy to build a solution for this :D

@fokusferit
Copy link
Contributor Author

Docs page is webpack.js.org so stuff needs to go there 😅

@rishabh3112
Copy link
Member

Yeah but I couldn't find the docs for webpack-cli there.

@fokusferit
Copy link
Contributor Author

Exactly. This is something this task should tackle.
We can collaborate on this, as I start with that topic and we could share tasks. Are you

@rishabh3112
Copy link
Member

https://cli.angular.io
Angular CLI has its own too ;)

@rishabh3112
Copy link
Member

@fokusferit we will be doing this at https://webpack.js.org or a standalone?

@fokusferit
Copy link
Contributor Author

@rishabh3112 they have it but in our case I think the CLI is an integral part so having them all in one place makes more sense & referencing to the CLI in that doc's will increase visibility :)

@webpack-bot
Copy link

This issue had no activity for at least half a year.

It's subject to automatic issue closing if there is no activity in the next 15 days.

@evenstensberg evenstensberg reopened this Mar 30, 2019
@evenstensberg evenstensberg changed the title Docs: Update README and Contributing guidelines [Docs]: Update README and Contributing guidelines Oct 31, 2019
@chaytanyasinha
Copy link

@evenstensberg May I work on this?

@webpack-bot
Copy link

This issue had no activity for at least half a year.

It's subject to automatic issue closing if there is no activity in the next 15 days.

@webpack-bot
Copy link

Issue was closed because of inactivity.

If you think this is still a valid issue, please file a new issue with additional information.

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

No branches or pull requests

6 participants