Skip to content

Update docs for sameSite option#2019

Open
camelmasa wants to merge 1 commit into
Shopify:v1.x-2022-07from
camelmasa:update-document
Open

Update docs for sameSite option#2019
camelmasa wants to merge 1 commit into
Shopify:v1.x-2022-07from
camelmasa:update-document

Conversation

@camelmasa

Copy link
Copy Markdown
Contributor

Description

Just updated docs for sameSite option.
Ref: https://github.com/Shopify/hydrogen/blob/ee370be6d74b330db78d95b85f1733c8ca3eb2d7/packages/hydrogen/src/foundation/Cookie/Cookie.ts#L16


Before submitting the PR, please make sure you do the following:

  • Read the Contributing Guidelines
  • Provide a description in this PR that addresses what the PR is solving, or reference the issue that it solves (e.g. fixes #123)
  • Update docs in this repository according to your change

@cartogram cartogram requested a review from rennyG August 22, 2022 10:55

@rennyG rennyG left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM. Does this change affect tutorials or other docs?

@camelmasa

Copy link
Copy Markdown
Contributor Author

I checked all docs in this repo. I don't think there is any other.

@camelmasa

Copy link
Copy Markdown
Contributor Author

I ignored that in CHANGELOG.md.

camelmasa@camelmasanoMacBook-Pro hydrogen % ag sameSite         
docs/framework/hydrogen-config.md
173:    sameSite: 'Strict',

docs/components/framework/cookie.md
19:  sameSite: 'Strict',
39:| sameSite | <code>"lax" &#124; "strict" &#124; "none"</code> | Declares that the cookie should be restricted to a first-party or [same-site](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie/SameSite) context.                                     |

docs/components/framework/filesessionstorage.md
23:    sameSite: 'Strict',

docs/components/framework/cookiesessionstorage.md
22:    sameSite: 'Strict',

docs/components/framework/memorysessionstorage.md
22:    sameSite: 'Strict',

examples/multipass/hydrogen.config.ts
13:    sameSite: 'Strict',

packages/hydrogen/CHANGELOG.md
1123:      sameSite: 'strict',
1165:  -    sameSite: 'strict',
1285:  +    sameSite: 'strict',

packages/hydrogen/src/foundation/Cookie/Cookie.ts
16:  sameSite?: 'Lax' | 'Strict' | 'None';

packages/create-hydrogen-app/CHANGELOG.md
244:  +    sameSite: 'strict',

templates/demo-store/hydrogen.config.ts
20:    sameSite: 'Strict',

@camelmasa

Copy link
Copy Markdown
Contributor Author

Ah, I need to change docs/components/framework/cookie.md... I'll do that!

@camelmasa

camelmasa commented Aug 23, 2022

Copy link
Copy Markdown
Contributor Author

DONE!

camelmasa@camelmasanoMacBook-Pro hydrogen % ag sameSite     
docs/framework/hydrogen-config.md
173:    sameSite: 'Strict',

docs/components/framework/cookie.md
19:  sameSite: 'Strict',
39:| sameSite | <code>"Lax" &#124; "Strict" &#124; "None"</code> | Declares that the cookie should be restricted to a first-party or [same-site](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie/SameSite) context.                                     |

docs/components/framework/filesessionstorage.md
23:    sameSite: 'Strict',

docs/components/framework/memorysessionstorage.md
22:    sameSite: 'Strict',

docs/components/framework/cookiesessionstorage.md
22:    sameSite: 'Strict',

examples/multipass/hydrogen.config.ts
13:    sameSite: 'Strict',

packages/hydrogen/CHANGELOG.md
1123:      sameSite: 'strict',
1165:  -    sameSite: 'strict',
1285:  +    sameSite: 'strict',

packages/hydrogen/src/foundation/Cookie/Cookie.ts
16:  sameSite?: 'Lax' | 'Strict' | 'None';

packages/create-hydrogen-app/CHANGELOG.md
244:  +    sameSite: 'strict',

templates/demo-store/hydrogen.config.ts
20:    sameSite: 'Strict',

@camelmasa

Copy link
Copy Markdown
Contributor Author

@rennyG Do we need to update other files?

@rennyG

rennyG commented Aug 29, 2022

Copy link
Copy Markdown
Contributor

@rennyG Do we need to update other files?

I did a search on this key/value in the shopify-dev repo, and it looks like no manual changes required there. When this PR is merged, though, we'll want the changes ported to shopify-dev. Let me know if you need a hand with that.

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