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

Add Clerk Express SDK docs #1201

Draft
wants to merge 41 commits into
base: main
Choose a base branch
from

Conversation

EmmanouelaPothitou
Copy link
Member

@EmmanouelaPothitou EmmanouelaPothitou commented Jun 26, 2024

Create documentation for the Express SDK and a guide for migrating from the Node SDK to Express SDK

Important

🔎 Previews:

@EmmanouelaPothitou EmmanouelaPothitou requested a review from a team as a code owner June 26, 2024 09:53
dimkl
dimkl previously requested changes Jun 28, 2024
{
"title": "Express.js",
"collapse": true,
"icon": "nodejs",
Copy link
Contributor

Choose a reason for hiding this comment

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

🔧 I think we should add and use an expressjs icon. You have already defined it in manifest.schema.json. The icon need to be added in the marketing site (check PR)

Copy link
Member Author

Choose a reason for hiding this comment

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

I've already talked with the design team to create an svg icon.

Copy link
Contributor

Choose a reason for hiding this comment

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

@alexisintech Why did we dismiss this review? We are still using the nodejs svg but we should update it.

Copy link
Member

Choose a reason for hiding this comment

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

@EmmanouelaPothitou any update on the svg icon ?

Copy link
Member Author

@EmmanouelaPothitou EmmanouelaPothitou Aug 6, 2024

Choose a reason for hiding this comment

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

I think this should be merged before this pr.

docs/references/express/available-methods.mdx Outdated Show resolved Hide resolved
docs/references/express/available-methods.mdx Outdated Show resolved Hide resolved
docs/references/express/available-methods.mdx Outdated Show resolved Hide resolved
docs/references/express/migrate-from-node-to-express.mdx Outdated Show resolved Hide resolved
docs/references/express/overview.mdx Outdated Show resolved Hide resolved
docs/references/express/overview.mdx Show resolved Hide resolved
docs/references/express/token-verification.mdx Outdated Show resolved Hide resolved
docs/references/express/token-verification.mdx Outdated Show resolved Hide resolved
docs/references/express/migrate-from-node-to-express.mdx Outdated Show resolved Hide resolved
@EmmanouelaPothitou EmmanouelaPothitou force-pushed the emmanouela/sdk-1694-stable-release-of-clerkexpress branch from c12e98b to 472d339 Compare July 1, 2024 10:17
@alexisintech
Copy link
Member

alexisintech commented Jul 1, 2024

please tag me to fully review once all the content is verified as correct by the other reviewers !

@alexisintech alexisintech requested review from alexisintech and removed request for alexisintech July 1, 2024 19:19
docs/references/express/available-methods.mdx Outdated Show resolved Hide resolved
docs/references/express/available-methods.mdx Outdated Show resolved Hide resolved
docs/references/express/available-methods.mdx Outdated Show resolved Hide resolved
docs/references/express/migrate-from-node-to-express.mdx Outdated Show resolved Hide resolved
docs/references/express/migrate-from-node-to-express.mdx Outdated Show resolved Hide resolved
docs/references/express/available-methods.mdx Outdated Show resolved Hide resolved
docs/references/express/overview.mdx Outdated Show resolved Hide resolved
@EmmanouelaPothitou EmmanouelaPothitou force-pushed the emmanouela/sdk-1694-stable-release-of-clerkexpress branch 2 times, most recently from e8f92b1 to 2ab9557 Compare July 9, 2024 20:18
@alexisintech
Copy link
Member

What is requireAuth ? We don't have this documented anywhere, but you mentioned that it's exported by the Express SDK @dimkl

@dimkl
Copy link
Contributor

dimkl commented Jul 18, 2024

@alexisintech it's a new export that's only included in the @clerk/express package (Express SDK). This PR is meant to document it.
code ref for requireAuth(): https://github.com/clerk/javascript/blob/main/packages/express/src/requireAuth.ts

Copy link
Contributor

@jescalan jescalan left a comment

Choose a reason for hiding this comment

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

Excited for this new package to land! Dropped a bunch of feedback on the docs 🙇‍♂️

@@ -0,0 +1,104 @@
---
Copy link
Contributor

Choose a reason for hiding this comment

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

I think maybe putting this under upgrade guides might make more sense

Copy link
Contributor

Choose a reason for hiding this comment

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

Aren't upgrade guides meant to be related to major Clerk upgrades? I think that we should keep it here since it's specific to the Clerk express package and how you can use it if you are already using the @clerk/clerk-sdk-node package.

docs/references/express/migrate-from-node-to-express.mdx Outdated Show resolved Hide resolved
docs/references/express/migrate-from-node-to-express.mdx Outdated Show resolved Hide resolved
docs/references/express/migrate-from-node-to-express.mdx Outdated Show resolved Hide resolved
docs/references/express/overview.mdx Outdated Show resolved Hide resolved
docs/references/express/overview.mdx Outdated Show resolved Hide resolved
docs/references/express/overview.mdx Outdated Show resolved Hide resolved
docs/references/express/overview.mdx Outdated Show resolved Hide resolved
docs/references/express/overview.mdx Outdated Show resolved Hide resolved
docs/references/express/overview.mdx Outdated Show resolved Hide resolved
docs/references/express/token-verification.mdx Outdated Show resolved Hide resolved
docs/references/express/available-methods.mdx Outdated Show resolved Hide resolved
docs/references/express/overview.mdx Outdated Show resolved Hide resolved
docs/references/express/overview.mdx Outdated Show resolved Hide resolved
docs/references/express/overview.mdx Outdated Show resolved Hide resolved
docs/references/express/overview.mdx Outdated Show resolved Hide resolved
docs/references/express/overview.mdx Outdated Show resolved Hide resolved
docs/references/express/overview.mdx Outdated Show resolved Hide resolved
@alexisintech alexisintech marked this pull request as draft July 18, 2024 19:21
Copy link

Hey, here’s your docs preview: https://clerk.com/docs/pr/1201

docs/references/express/require-auth.mdx Outdated Show resolved Hide resolved
docs/references/express/require-auth.mdx Outdated Show resolved Hide resolved
Copy link
Contributor

@jescalan jescalan left a comment

Choose a reason for hiding this comment

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

It's getting closer here!

docs/references/express/migrate-from-node-to-express.mdx Outdated Show resolved Hide resolved
docs/references/express/migrate-from-node-to-express.mdx Outdated Show resolved Hide resolved
docs/references/express/overview.mdx Outdated Show resolved Hide resolved
docs/references/express/overview.mdx Outdated Show resolved Hide resolved
docs/references/express/overview.mdx Outdated Show resolved Hide resolved
docs/references/express/overview.mdx Show resolved Hide resolved
docs/references/express/require-auth.mdx Outdated Show resolved Hide resolved
@alexisintech alexisintech changed the title Emmanouela/sdk 1694 stable release of clerkexpress Add Clerk Express SDK docs Aug 2, 2024
@alexisintech alexisintech marked this pull request as ready for review August 2, 2024 17:20
{
"title": "Express.js",
"collapse": true,
"icon": "nodejs",
Copy link
Contributor

Choose a reason for hiding this comment

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

@alexisintech Why did we dismiss this review? We are still using the nodejs svg but we should update it.

@@ -0,0 +1,104 @@
---
Copy link
Contributor

Choose a reason for hiding this comment

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

Aren't upgrade guides meant to be related to major Clerk upgrades? I think that we should keep it here since it's specific to the Clerk express package and how you can use it if you are already using the @clerk/clerk-sdk-node package.

@jescalan
Copy link
Contributor

jescalan commented Aug 5, 2024

@dimkl

Aren't upgrade guides meant to be related to major Clerk upgrades? I think that we should keep it here since it's specific to the Clerk express package and how you can use it if you are already using the @clerk/clerk-sdk-node package.

This is a major upgrade imo. We're deprecating the sdk-node package, and anyone using the sdk-node package needs to migrate over to a completely different package that is massively breaking. I think this is the appropriate place for such a guide.

@alexisintech alexisintech marked this pull request as draft August 9, 2024 16:01
@wobsoriano wobsoriano force-pushed the emmanouela/sdk-1694-stable-release-of-clerkexpress branch from 0c67602 to a18f034 Compare September 19, 2024 18:48
@wobsoriano
Copy link
Member

Hi team, I've updated the PR with some clean-ups and added a quickstart page for the Express SDK. I think it's ready for review! Thanks all

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants