Skip to content

Commit 5f7229b

Browse files
EmyrkEmyrk
committed
chore: fixup docs around org sync cli
1 parent 7876dc5 commit 5f7229b

11 files changed

+36
-22
lines changed

‎cli/organizationsettings.go

+7-3
Original file line numberDiff line numberDiff line change
@@ -49,9 +49,11 @@ func (r *RootCmd) organizationSettings(orgContext *OrganizationContext) *serpent
4949
},
5050
},
5151
{
52-
Name: "organization-sync",
53-
Aliases: []string{"organizationsync", "org-sync", "orgsync"},
54-
Short: "Organization sync settings to sync organization memberships from an IdP.",
52+
Name: "organization-sync",
53+
Aliases: []string{"organizationsync", "org-sync", "orgsync"},
54+
Short: "Organization sync settings to sync organization memberships from an IdP. This applies to all organizations.",
55+
Long: "Organization sync settings works across all organizations. The sync will automatically add members to" +
56+
"organizations based on the IdP claims. Deployment administrators can configure this sync.",
5557
DisableOrgContext: true,
5658
Patch: func(ctx context.Context, cli *codersdk.Client, _ uuid.UUID, input json.RawMessage) (any, error) {
5759
var req codersdk.OrganizationSyncSettings
@@ -85,6 +87,7 @@ type organizationSetting struct {
8587
Name string
8688
Aliases []string
8789
Short string
90+
Long string
8891
// DisableOrgContext is kinda a kludge. It tells the command constructor
8992
// to not require an organization context. This is used for the organization
9093
// sync settings which are not tied to a specific organization.
@@ -122,6 +125,7 @@ func (r *RootCmd) setOrganizationSettings(orgContext *OrganizationContext, setti
122125
Use: set.Name,
123126
Aliases: set.Aliases,
124127
Short: set.Short,
128+
Long: set.Long,
125129
Options: []serpent.Option{},
126130
Middleware: serpent.Chain(
127131
serpent.RequireNArgs(0),

‎cli/testdata/coder_organizations_settings_set_--help.golden

+2-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,8 @@ USAGE:
1212
SUBCOMMANDS:
1313
group-sync Group sync settings to sync groups from an IdP.
1414
organization-sync Organization sync settings to sync organization
15-
memberships from an IdP.
15+
memberships from an IdP. This applies to all
16+
organizations.
1617
role-sync Role sync settings to sync organization roles from an
1718
IdP.
1819

‎cli/testdata/coder_organizations_settings_set_--help_--help.golden

+2-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,8 @@ USAGE:
1212
SUBCOMMANDS:
1313
group-sync Group sync settings to sync groups from an IdP.
1414
organization-sync Organization sync settings to sync organization
15-
memberships from an IdP.
15+
memberships from an IdP. This applies to all
16+
organizations.
1617
role-sync Role sync settings to sync organization roles from an
1718
IdP.
1819

‎cli/testdata/coder_organizations_settings_show_--help.golden

+2-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,8 @@ USAGE:
1212
SUBCOMMANDS:
1313
group-sync Group sync settings to sync groups from an IdP.
1414
organization-sync Organization sync settings to sync organization
15-
memberships from an IdP.
15+
memberships from an IdP. This applies to all
16+
organizations.
1617
role-sync Role sync settings to sync organization roles from an
1718
IdP.
1819

‎cli/testdata/coder_organizations_settings_show_--help_--help.golden

+2-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,8 @@ USAGE:
1212
SUBCOMMANDS:
1313
group-sync Group sync settings to sync groups from an IdP.
1414
organization-sync Organization sync settings to sync organization
15-
memberships from an IdP.
15+
memberships from an IdP. This applies to all
16+
organizations.
1617
role-sync Role sync settings to sync organization roles from an
1718
IdP.
1819

‎coderd/rbac/input.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"action": "never-match-action",
2+
"action": "read",
33
"object": {
44
"id": "9046b041-58ed-47a3-9c3a-de302577875a",
55
"owner": "00000000-0000-0000-0000-000000000000",

‎docs/manifest.json

+2-2
Original file line numberDiff line numberDiff line change
@@ -1063,7 +1063,7 @@
10631063
},
10641064
{
10651065
"title": "organizations settings set organization-sync",
1066-
"description": "Organization sync settings to sync organization memberships from an IdP.",
1066+
"description": "Organization sync settings to sync organization memberships from an IdP. This applies to all organizations.",
10671067
"path": "reference/cli/organizations_settings_set_organization-sync.md"
10681068
},
10691069
{
@@ -1083,7 +1083,7 @@
10831083
},
10841084
{
10851085
"title": "organizations settings show organization-sync",
1086-
"description": "Organization sync settings to sync organization memberships from an IdP.",
1086+
"description": "Organization sync settings to sync organization memberships from an IdP. This applies to all organizations.",
10871087
"path": "reference/cli/organizations_settings_show_organization-sync.md"
10881088
},
10891089
{

‎docs/reference/cli/organizations_settings_set.md

+5-5
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/reference/cli/organizations_settings_set_organization-sync.md

+7-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/reference/cli/organizations_settings_show.md

+5-5
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/reference/cli/organizations_settings_show_organization-sync.md

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)