-
Notifications
You must be signed in to change notification settings - Fork 885
Reorganize and restructure Organization docs #2758
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
Open
im2nguyen
wants to merge
72
commits into
main
Choose a base branch
from
im2nguyen/refactor-org-docs
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 65 commits
Commits
Show all changes
72 commits
Select commit
Hold shift + click to select a range
0280654
Reorganize and restructure Organization docs
9f7ac66
fix linting errors, hopefully fix build errors
8ca739d
Merge branch 'main' into im2nguyen/refactor-org-docs
im2nguyen 884b852
anotha attempt to fix build errors
f2ca024
last missing file error in build
be700f3
update copy for active voice
f58ef2a
add relevant links to sso and auth-checks
019a616
fix linting error, add placeholder diagram for org relationship
27bb678
docs review
alexisintech d734d2d
update overview
alexisintech 6913823
another overview update; update metadata
alexisintech 772f1d3
update authorization checks metadata
alexisintech faec6dd
link fixes
alexisintech 4de425d
Merge branch 'main' into im2nguyen/refactor-org-docs
im2nguyen 0d288fb
Merge branch 'main' into im2nguyen/refactor-org-docs
SarahSoutoul ef57b7d
docs review pt2
SarahSoutoul 71713d2
Remove typedoc
SarahSoutoul b8fa177
Merge branch 'main' into im2nguyen/refactor-org-docs
im2nguyen 0fa0ffc
Update docs/guides/organizations/configure.mdx
SarahSoutoul 66d4a08
Update docs/guides/organizations/create-and-manage.mdx
SarahSoutoul 6c0a1d0
Apply suggestions from code review
SarahSoutoul 755bf56
Linting and fix link
SarahSoutoul 56b26e0
Merge branch 'main' into im2nguyen/refactor-org-docs
im2nguyen e0921ae
reconcile changes from main
53018c5
fix build errors
6f50cbc
add orgs quickstart
4853b4a
remove diagram based on feedback
ee543a0
simplify overview page even further
3e70777
hopefully fix all build errors?
9307abf
lint files so it passes checks
66daa0f
docs review updates
alexisintech 4017943
Remove clerk typedoc direct change
SarahSoutoul b720ae3
Re-add clerk typedoc
SarahSoutoul fa41ceb
Merge branch 'main' into im2nguyen/refactor-org-docs
im2nguyen 8615550
readd add-members to sidebar
606dacb
clean up sidebar
8a320bf
Merge branch 'main' into im2nguyen/refactor-org-docs
im2nguyen a22eff3
rerun lint
96bfc31
fix lint problems
5f919bb
revert changes to files
3b4294c
Merge branch 'main' into im2nguyen/refactor-org-docs
im2nguyen 9c4dffa
create get started w orgs, more streamlined than quickstart
534566a
fix broken links
4a10ebc
remove hash
1875703
run lint on changed files
be87081
experiment with changes, update title
28395b7
fix lint errors, update copy for quickstart
85a739c
Bring back correct formattign TutorialHero
SarahSoutoul 8f5ea07
More removal of unnecessary linting
SarahSoutoul 9a6d925
docs review
SarahSoutoul b21e03a
Linting
SarahSoutoul a411070
docs review
alexisintech fa64d14
update diagram
6a4dadf
Update docs/guides/organizations/add-members/verified-domains.mdx
im2nguyen 4caa01b
remove callout from tutorial
alexisintech 52bd170
fix redirects
alexisintech 6f92625
Update redirects/static/docs.json
im2nguyen ed19aff
add line about how to assign custom perm to a user
alexisintech b40ac94
quickstart (tus version)
4bf0772
Merge branch 'main' into im2nguyen/refactor-org-docs
im2nguyen cf55d8c
wrap component name in backticks to escape
aff5ac1
lint files
daeaf57
restructure getstarted orgs content
9076e33
fix build error
8176513
Merge branch 'main' into im2nguyen/refactor-org-docs
im2nguyen 6abd3a0
Apply suggestions from code review
im2nguyen 702653c
incorporate review feedback (Alexis and Sarah!)
71202ff
Update docs/guides/organizations/get-started-tu/quickstart.mdx
im2nguyen fe9c8d9
Update docs/guides/organizations/get-started-tu/quickstart.mdx
im2nguyen 472fa3f
linting
f923717
capitalize clerk features
alexisintech 506d44f
Merge branch 'main' into im2nguyen/refactor-org-docs
alexisintech File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,3 @@ | ||
| `OrganizationCustomRoleKey` is a type that represents the user's role in an organization. It will be string unless the developer has provided their own types through [`ClerkAuthorization`](/docs/guides/development/override-clerk-types-interfaces#example-custom-roles-and-permissions). | ||
|
|
||
| Clerk provides the [default roles](/docs/guides/organizations/roles-and-permissions#default-roles) `org:admin` and `org:member`. However, you can create [custom roles](/docs/guides/organizations/roles-and-permissions#custom-roles) as well. | ||
| Clerk provides the [default roles](/docs/guides/organizations/control-access/roles-and-permissions#default-roles) `org:admin` and `org:member`. However, you can create [custom roles](/docs/guides/organizations/control-access/roles-and-permissions#custom-roles) as well. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,6 @@ | ||
| | Property | Type | Description | | ||
| | ----------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ||
| | <a id="domains"></a> `domains?` | <code>true \| \{ initialPage?: number; pageSize?: number; \} & \{ enrollmentMode?: "manual_invitation" \| "automatic_invitation" \| "automatic_suggestion"; \} & \{ infinite?: boolean; keepPreviousData?: boolean; \}</code> | If set to `true`, all default properties will be used.<br /> Otherwise, accepts an object with the following optional properties: <ul> <li>`enrollmentMode`: A string that filters the domains by the provided [enrollment mode](/docs/guides/organizations/verified-domains#enrollment-mode).</li> <li>Any of the properties described in [Shared properties](#shared-properties).</li> </ul> | | ||
| | <a id="domains"></a> `domains?` | <code>true \| \{ initialPage?: number; pageSize?: number; \} & \{ enrollmentMode?: "manual_invitation" \| "automatic_invitation" \| "automatic_suggestion"; \} & \{ infinite?: boolean; keepPreviousData?: boolean; \}</code> | If set to `true`, all default properties will be used.<br /> Otherwise, accepts an object with the following optional properties: <ul> <li>`enrollmentMode`: A string that filters the domains by the provided [enrollment mode](/docs/guides/organizations/add-members/verified-domains#enrollment-mode).</li> <li>Any of the properties described in [Shared properties](#shared-properties).</li> </ul> | | ||
| | <a id="invitations"></a> `invitations?` | <code>true \| \{ initialPage?: number; pageSize?: number; \} & \{ status?: ("expired" \| "pending" \| "accepted" \| "revoked")[]; \} & \{ infinite?: boolean; keepPreviousData?: boolean; \}</code> | If set to `true`, all default properties will be used.<br /> Otherwise, accepts an object with the following optional properties: <ul> <li>`status`: A string that filters the invitations by the provided status.</li> <li>Any of the properties described in [Shared properties](#shared-properties).</li> </ul> | | ||
| | <a id="membershiprequests"></a> `membershipRequests?` | <code>true \| \{ initialPage?: number; pageSize?: number; \} & \{ status?: "expired" \| "pending" \| "accepted" \| "revoked"; \} & \{ infinite?: boolean; keepPreviousData?: boolean; \}</code> | If set to `true`, all default properties will be used.<br /> Otherwise, accepts an object with the following optional properties: <ul> <li>`status`: A string that filters the membership requests by the provided status.</li> <li>Any of the properties described in [Shared properties](#shared-properties).</li> </ul> | | ||
| | <a id="memberships"></a> `memberships?` | <code>true \| \{ initialPage?: number; pageSize?: number; \} & \{ query?: string; role?: string[]; \} & \{ infinite?: boolean; keepPreviousData?: boolean; \}</code> | If set to `true`, all default properties will be used.<br /> Otherwise, accepts an object with the following optional properties: <ul> <li>`role`: An array of [`OrganizationCustomRoleKey`](/docs/reference/javascript/types/organization-custom-role-key).</li> <li>`query`: A string that filters the memberships by the provided string.</li> <li>Any of the properties described in [Shared properties](#shared-properties).</li> </ul> | |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,2 +1,2 @@ | ||
| > [!WARNING] | ||
| > Using `has()` **on the server-side** to check permissions works only with **custom permissions**, as [system permissions](/docs/guides/organizations/roles-and-permissions#system-permissions) aren't included in the session token claims. To check system permissions, verify the user's role instead. | ||
| > Using `has()` **on the server-side** to check permissions works only with **custom permissions**, as [system permissions](/docs/guides/organizations/control-access/roles-and-permissions#system-permissions) aren't included in the session token claims. To check system permissions, verify the user's role instead. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The linting is still here for a few
TutorialHerobut decided to keep those because they're actually not properly indented onmain. Could remove tho, and we can do it as a separate PR. @alexisintech