这是indexloc提供的服务，不要输入任何密码
Skip to content

Add Workspaces guide #884

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 37 commits into from
May 31, 2022
Merged

Add Workspaces guide #884

merged 37 commits into from
May 31, 2022

Conversation

rafaeltab
Copy link
Contributor

Closes #874.

Currently, still just a draft, any suggestions are appreciated.

@vercel
Copy link

vercel bot commented Mar 14, 2022

@rafaeltab is attempting to deploy a commit to the Vercel Team on Vercel.

A member of the Team first needs to authorize it.

@rafaeltab rafaeltab marked this pull request as ready for review March 14, 2022 20:20
fivethreeo
fivethreeo reviewed Mar 14, 2022
View reviewed changes
@vercel
Copy link

vercel bot commented Mar 16, 2022 •
edited
Loading

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/vercel/turbo-site/6gyxjceSFGySyqu8MViMx5hVHaCo
✅ Preview: https://turbo-site-git-fork-rafaeltab-docs-beginners-guide.vercel.sh

@rafaeltab rafaeltab mentioned this pull request Mar 16, 2022
Closed
@rafaeltab
Copy link
Contributor Author

rafaeltab commented Mar 16, 2022 •
edited
Loading

The preview doesn't seem to have the last 4 commits :/

becca
becca reviewed Mar 16, 2022
View reviewed changes
rafaeltab and others added 2 commits March 16, 2022 22:25
@rafaeltab
docs: lots of spelling corrections, sentence improvements, and punctu…
ab75e00 
…ation fixing
@rafaeltab @becca
Commit suggestion from becca
0cdfbc4 
Co-authored-by: Becca Z <23545426+becca@users.noreply.github.com>
@rafaeltab
Copy link
Contributor Author

Are there more suggestions? If not, I think this is finished, and ready for merge.

jaredpalmer
jaredpalmer suggested changes Apr 13, 2022
View reviewed changes
jaredpalmer
jaredpalmer suggested changes Apr 15, 2022
View reviewed changes
Copy link
Contributor

@jaredpalmer jaredpalmer left a comment

Choose a reason for hiding this comment

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

Progress:

  • Let's drop the word "beginner" entirely from this guide now
  • Let's expand more on "what are workspaces?" in first paragraph and why are they useful. We should also call out "workspaces" vs. "workspace" vs. jargon ("package" and "packages")

@jaredpalmer jaredpalmer changed the title Add beginners guide to the docs Add Workspaces guide May 2, 2022
jaredpalmer
jaredpalmer suggested changes May 2, 2022
View reviewed changes
Copy link
Contributor

@jaredpalmer jaredpalmer left a comment

Choose a reason for hiding this comment

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

Refactor to include:

@rafaeltab
Copy link
Contributor Author

Oh, Jesus! You spent a lot of time on the review, I wasn't really done with the changes just yet, just didn't have time to make any :/
You still added some good info that I wasn't going to implement, though, I'll get the changes finished within a few hours.

rafaeltab and others added 13 commits May 2, 2022 19:11
@rafaeltab
docs: lowercase name in workspaces guide documentation list
90f4248
@rafaeltab
docs: Less roundabout way of starting to describe workspaces
3e64446
@rafaeltab
docs: add examples for workspace configuration, and its effect on a f…
1607ff6 
…older structure
@rafaeltab
Merge branch 'main' into docs/beginners-guide
4c1bc8c
@rafaeltab
docs: Use tabs for installing packages section
28bf12d
@rafaeltab
docs: no more beginner in Installing packages
9bef4d3
@rafaeltab
docs: nothing is obvious for everyone
c1027e6
@rafaeltab
docs: changes to the first sentence of the 'What are workspaces?' sec…
2cd411d 
…tion
@rafaeltab @jaredpalmer
docs: change to introduction of workspace implementations
4298a91 
Co-authored-by: Jared Palmer <jared@jaredpalmer.com>
@rafaeltab
docs: start refactor of adding workspaces section
60351f4
@rafaeltab
docs: complete refactor of 'Adding workspaces' section
031433d
@rafaeltab
docs: clearer naming conventions
1a25ac1
@rafaeltab
Merge branch 'main' into docs/beginners-guide
c714e1c
@rafaeltab rafaeltab requested a review from jaredpalmer May 2, 2022 21:05
@rafaeltab
Copy link
Contributor Author

I made the changes, in my opinion it all became a lot clearer. The tabs are very nice.

jaredpalmer
jaredpalmer suggested changes May 2, 2022
View reviewed changes
@rafaeltab rafaeltab requested a review from jaredpalmer May 2, 2022 21:46
@rafaeltab rafaeltab mentioned this pull request May 31, 2022
Merged
@jaredpalmer jaredpalmer merged commit fa4c8de into vercel:main May 31, 2022
@mehulkar mehulkar mentioned this pull request Sep 8, 2022
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@fivethreeo fivethreeo fivethreeo left review comments

@becca becca becca left review comments

@gsoltis gsoltis Awaiting requested review from gsoltis

@gaspar09 gaspar09 Awaiting requested review from gaspar09

@nathanhammond nathanhammond Awaiting requested review from nathanhammond

@jaredpalmer jaredpalmer Awaiting requested review from jaredpalmer

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Add a beginner guide to the docs
4 participants
@rafaeltab @fivethreeo @jaredpalmer @becca