Skip to content

Add new RTK Query pages to the "Essentials" tutorial #4153

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

Merged
merged 6 commits into from
Aug 29, 2021

Conversation

markerikson
Copy link
Contributor

@markerikson markerikson commented Aug 21, 2021

Overview

This PR:

  • Adds new pages to the Essentials tutorial covering how to use RTK Query
  • Cleans up the Essentials tutorial to reflect updates in usage patterns (such as the "builder callback" syntax for extraReducers)
  • Fixes several bits of explanation that had been skipped over during the original tutorial content for space and were identified as being confusing

Status

This is a very rough first draft of the first half of the planned content. As in, I just got done writing for the last few hours :)

So far I've got a "Part 7: RTKQ Basics" page written up, as seen here. I plan to add a "Part 8: RTKQ Advanced Patterns" page covering the rest of the example commits (page name TBD).

I've just added the "Advanced" page first draft to go along with the "Basics" page.

I've also got a third draft of the planned example app code completed, and have just pushed that up to https://github.com/reduxjs/redux-essentials-example-app/tree/tutorial-steps-2021-08-14.

I also will need to go through and do some more cleanup of the earlier sections of the Essentials tutorial, applying some of the feedback from existing issues.

I've got the content basically complete at this point. New pages should be done. Fixed up the existing pages to match the latest code and fill in some missing explanations, and addressed the review comments.

Only thing that should be left at this point is updating the example repo with the final code in the tutorial-steps branch, adding the right tags, and filling in the Sandboxes for the new pages.

The nearly-final example code is viewable at https://github.com/reduxjs/redux-essentials-example-app/tree/tutorial-steps-2021-08-28 .

The new content is previewable at https://deploy-preview-4153--redux-docs.netlify.app/tutorials/essentials/part-7-rtk-query-basics .

@codesandbox-ci
Copy link

codesandbox-ci bot commented Aug 21, 2021

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

Latest deployment of this branch, based on commit 3217c6d:

Sandbox Source
Vanilla Configuration
Vanilla Typescript Configuration

@github-actions
Copy link

github-actions bot commented Aug 21, 2021

Size Change: 0 B

Total Size: 8.61 kB

ℹ️ View Unchanged
Filename Size Change
dist/redux.js 6.89 kB 0 B
dist/redux.min.js 1.72 kB 0 B

compressed-size-action

@netlify
Copy link

netlify bot commented Aug 21, 2021

✔️ Deploy Preview for redux-docs ready!

🔨 Explore the source changes: 3217c6d

🔍 Inspect the deploy log: https://app.netlify.com/sites/redux-docs/deploys/612c0987e4a33d000799ffaa

😎 Browse the preview: https://deploy-preview-4153--redux-docs.netlify.app

@markerikson markerikson force-pushed the docs/essentials-rtkq branch from bb633a3 to 421f696 Compare August 21, 2021 22:40
Copy link
Member

@phryneas phryneas left a comment

Choose a reason for hiding this comment

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

Read through part 7, all I have are nitpicks. This is already very polished, like always :)
Probably gonna read through part 8 tomorrow.

Copy link
Contributor

@Shrugsy Shrugsy left a comment

Choose a reason for hiding this comment

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

Awesome content @markerikson!

I've left some nitpicks/questions/spelling-fixes to look at

- Added sections describing adding the PostExcerpt and EditPostForm
  components, per issues
- Updated `extraReducers` usage to focus on builder callback syntax
@markerikson markerikson changed the title [DRAFT] Add new RTK Query pages to the "Essentials" tutorial Add new RTK Query pages to the "Essentials" tutorial Aug 28, 2021
@markerikson markerikson marked this pull request as ready for review August 28, 2021 21:44
@markerikson
Copy link
Contributor Author

Ready to roll!

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.

3 participants