Skip to content
This repository has been archived by the owner on Apr 11, 2024. It is now read-only.

Document CustomSessionStorage example #129

Merged
merged 3 commits into from
Mar 16, 2021
Merged

Conversation

thecodepixi
Copy link
Contributor

@thecodepixi thecodepixi commented Mar 9, 2021

WHY are these changes introduced?

Fixes #121

WHAT is this pull request doing?

Adds documentation and example code for a CustomSessionStorage solution.

Type of change

  • Patch: Bug (non-breaking change which fixes an issue)
    - [ ] Minor: New feature (non-breaking change which adds functionality)
    - [ ] Major: Breaking change (fix or feature that would cause existing functionality to not work as expected)

Checklist

  • I have added a changelog entry, prefixed by the type of change noted above
    - [ ] I have added/updated tests for this change
    - [ ] I have documented new APIs/updated the documentation for modified APIs (for public APIs)

@thecodepixi thecodepixi force-pushed the custom-session-docs branch 2 times, most recently from 8e59c84 to 3bb0cd7 Compare March 9, 2021 20:42
@thecodepixi thecodepixi changed the title [WIP] Document CustomSessionStorage example Document CustomSessionStorage example Mar 9, 2021
@thecodepixi thecodepixi marked this pull request as ready for review March 9, 2021 20:43
@thecodepixi thecodepixi requested a review from a team as a code owner March 9, 2021 20:43
@thecodepixi
Copy link
Contributor Author

I have a feeling this will need a bit more polish. Curious for feedback on both the general content and the code samples. I'm also curious what we should do with the existing docs around session handling under Known Issues as it applies to CustomeSessionStorage.

docs/usage/customsessions.md Outdated Show resolved Hide resolved
docs/usage/customsessions.md Outdated Show resolved Hide resolved
docs/usage/customsessions.md Outdated Show resolved Hide resolved
docs/usage/customsessions.md Outdated Show resolved Hide resolved
docs/usage/customsessions.md Outdated Show resolved Hide resolved
@paulomarg
Copy link
Contributor

paulomarg commented Mar 9, 2021

I have a feeling this will need a bit more polish. Curious for feedback on both the general content and the code samples. I'm also curious what we should do with the existing docs around session handling under Known Issues as it applies to CustomeSessionStorage.

I'd edit the current page to say something like 'you'll need to implement your own class, here is one way to do it'.

Copy link
Contributor

@gfscott gfscott left a comment

Choose a reason for hiding this comment

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

Looks great!

docs/usage/customsessions.md Outdated Show resolved Hide resolved
docs/usage/customsessions.md Outdated Show resolved Hide resolved
docs/usage/customsessions.md Outdated Show resolved Hide resolved
@thecodepixi
Copy link
Contributor Author

A couple updates: Incorporated the suggested changes (thanks for all the input!). I also added some closing remarks to the end of the guide since it ended a bit abruptly, and called out that this is only one of many possible solutions. I'm curious about how the update to the install dependencies section looks. The Redis docs only have one suggested installation, so I added a note to callout that Mac users can install with homebrew.

Copy link
Contributor

@paulomarg paulomarg left a comment

Choose a reason for hiding this comment

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

I'm curious about how the update to the install dependencies section looks

Looks great to me. It clearly states that it is one possible way of doing it, and provides instructions on how to get started with it.

I would however, consider changing the current notes on sessions page to link to this one instead of providing its own example, which is too simplistic compared to this one!

docs/index.md Outdated Show resolved Hide resolved
docs/index.md Outdated
@@ -21,5 +21,8 @@ You can follow our getting started guide, which will provide instructions on how
- [Webhooks](usage/webhooks.md)
Copy link
Contributor

Choose a reason for hiding this comment

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

Are we updating the getting started guide index accordingly?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I took a look and don't think anything we're doing here effects the getting started guide.

@thecodepixi thecodepixi force-pushed the custom-session-docs branch 3 times, most recently from 3e12d5e to 96d2057 Compare March 11, 2021 22:17
@thecodepixi thecodepixi requested a review from paulomarg March 11, 2021 22:18
Copy link
Contributor

@paulomarg paulomarg left a comment

Choose a reason for hiding this comment

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

LGTM, but there is one thing that got mentioned on a different issue - let's make it clear that storeCallback expects to be called multiple times for the same session id, so it should be able to update existing entries.

@thecodepixi
Copy link
Contributor Author

thecodepixi commented Mar 15, 2021

LGTM, but there is one thing that got mentioned on a different issue - let's make it clear that storeCallback expects to be called multiple times for the same session id, so it should be able to update existing entries.

Good point! I will add a call-out/note about that and then get this merged in.

@thecodepixi thecodepixi force-pushed the custom-session-docs branch from 6490bee to 57253ef Compare March 15, 2021 19:55
@thecodepixi thecodepixi force-pushed the custom-session-docs branch from 57253ef to 00bcc43 Compare March 15, 2021 20:01
@thecodepixi thecodepixi force-pushed the custom-session-docs branch from 00bcc43 to c194be4 Compare March 15, 2021 20:05
Copy link
Contributor

@paulomarg paulomarg left a comment

Choose a reason for hiding this comment

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

LGTM!

@thecodepixi thecodepixi merged commit 617b7c5 into main Mar 16, 2021
@thecodepixi thecodepixi deleted the custom-session-docs branch March 16, 2021 18:23
@shopify-shipit shopify-shipit bot temporarily deployed to production March 26, 2021 18:46 Inactive
# for free to subscribe to this conversation on GitHub. Already have an account? #.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documentation improvements
4 participants