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

WIP: examples folder refactoring #3919

Conversation

giacomocerquone
Copy link
Contributor

@giacomocerquone giacomocerquone commented Oct 25, 2020


name: 📖 New/Updated Documentation Content
about: Adding a new docs page, or updating content in an existing docs page

PR Type

Does this PR add a new page, or update an existing page?

Not yet

Checklist

What docs page is being added or updated?

  • Section: Introduction
  • Page: Examples

For Updating Existing Content

What updates should be made to the page?

Linking updated redux examples

Do these updates change any of the assumptions or target audience? If so, how do they change?

No

@netlify
Copy link

netlify bot commented Oct 25, 2020

Deploy preview for redux-docs ready!

Built with commit 6dd920b

https://deploy-preview-3919--redux-docs.netlify.app

@markerikson
Copy link
Contributor

Ho-ly smoke, that's a big PR :)

(I know, I know, most of it is package-lock.json files being removed).

First observation: since there may be external links that still point to those folders, can we replace the dead examples with small README.md files that have specific suggestions on what other examples to look at instead? ie, examples/todomvc/README.md might say "Go look at the new Redux Fundamentals example todo app -> here".

@giacomocerquone
Copy link
Contributor Author

giacomocerquone commented Oct 25, 2020

@markerikson wait wait, I did nothing else but removing the folders we said to remove and replacing the counter example with "npx create-react-app --template=redux"
If you want I can split every example deleted in its own PR, your choice 🙂

Good idea for the readme, plus i'm putting a codesandbox in the Examples.md both for the redux essentials and the fundamentals repos

@markerikson
Copy link
Contributor

I'm fine with the one PR - just saying that +12.2K -66K is a pretty big diff :)

@giacomocerquone
Copy link
Contributor Author

YOLO 😄

docs/introduction/Examples.md Outdated Show resolved Hide resolved
docs/introduction/Examples.md Outdated Show resolved Hide resolved
@timdorr
Copy link
Member

timdorr commented Oct 25, 2020

Please don't switch to Yarn. We use npm for this repo.

@markerikson
Copy link
Contributor

@timdorr good catch, I missed that.

Although I think I may have used Yarn for the "Essentials" tutorial repo? At least the README file ended up saying yarn build, etc, although I didn't include a lockfile in there.

@timdorr
Copy link
Member

timdorr commented Oct 25, 2020

I don't really care much about the tooling in other repos or even what that tooling is. It's just we should use one package manager per repo, so that tooling usage will be consistent. And so the install scripts for the examples have the right lock file format available (even though npm 7 can read yarn.lock now)

@giacomocerquone
Copy link
Contributor Author

Let me know if I can improve this pr anytime :)
Just ping!

Copy link
Contributor

@juzhiyuan juzhiyuan left a comment

Choose a reason for hiding this comment

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

TL;DR we’d better split this PR into more smaller PRs.

@reduxjs reduxjs deleted a comment from mindtraveller Sep 7, 2021
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.

4 participants