Skip to content

docs: move premium and enterprise badges from heading to info in admonition #15774

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

Merged
merged 8 commits into from
Dec 17, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
move premium from heading to admonition
  • Loading branch information
EdwardAngert authored and EdwardAngert committed Dec 6, 2024
commit 0658f5acad55e36974dbe48f793779773ed182db
8 changes: 8 additions & 0 deletions .vscode/markdown.code-snippets
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,14 @@
"body": "![${TM_SELECTED_TEXT:${1:alt}}](${2:url})$0",
"description": "image"
},
"premium-feature": {
"prefix": "#premium-feature",
"body": [
"<blockquote class=\"admonition tip\">\n",
"${1:feature} ${2|is,are|} an Enterprise and Premium feature. [Learn more](https://coder.com/pricing#compare-plans).\n",
"</blockquote>"
]
},
"tabs": {
"prefix": "#tabs",
"body": [
Expand Down
15 changes: 10 additions & 5 deletions docs/admin/external-auth.md
Original file line number Diff line number Diff line change
Expand Up @@ -179,11 +179,16 @@ Optionally, you can request custom scopes:
CODER_EXTERNAL_AUTH_0_SCOPES="repo:read repo:write write:gpg_key"
```

## Multiple External Providers (enterprise) (premium)
## Multiple External Providers

Multiple providers are an Enterprise feature.
[Learn more](https://coder.com/pricing#compare-plans). Below is an example
configuration with multiple providers.
<blockquote class="admonition tip">

Multiple providers is an Enterprise and Premium feature.
[Learn more](https://coder.com/pricing#compare-plans).

</blockquote>

Below is an example configuration with multiple providers:

```env
# Provider 1) github.com
Expand All @@ -204,7 +209,7 @@ CODER_EXTERNAL_AUTH_1_TOKEN_URL="https://github.example.com/login/oauth/access_t
CODER_EXTERNAL_AUTH_1_VALIDATE_URL="https://github.example.com/api/v3/user"
```

To support regex matching for paths (e.g. github\.com/org), you'll need to add
To support regex matching for paths (e.g. `github\.com/org`), you'll need to add
this to the
[Coder agent startup script](https://registry.terraform.io/providers/coder/coder/latest/docs/resources/agent#startup_script):

Expand Down
9 changes: 8 additions & 1 deletion docs/admin/monitoring/notifications/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -232,7 +232,14 @@ notification is indicated on the right hand side of this table.

![User Notification Preferences](../../../images/admin/monitoring/notifications/user-notification-preferences.png)

## Delivery Preferences (enterprise) (premium)
## Delivery Preferences

<blockquote class="admonition tip">

Delivery preferences is an Enterprise and Premium feature.
[Learn more](https://coder.com/pricing#compare-plans).

</blockquote>

Administrators can configure which delivery methods are used for each different
[event type](#event-types).
Expand Down
18 changes: 16 additions & 2 deletions docs/admin/networking/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -176,7 +176,14 @@ coder server, so they can only be geo-distributed with High Availability mode in
our Premium Edition. [Reach out to Sales](https://coder.com/contact) to learn
more.

## Browser-only connections (enterprise) (premium)
## Browser-only connections

<blockquote class="admonition tip">

Browser-only connections is an Enterprise and Premium feature.
[Learn more](https://coder.com/pricing#compare-plans).

</blockquote>

Some Coder deployments require that all access is through the browser to comply
with security policies. In these cases, pass the `--browser-only` flag to
Expand All @@ -186,7 +193,14 @@ With browser-only connections, developers can only connect to their workspaces
via the web terminal and
[web IDEs](../../user-guides/workspace-access/web-ides.md).

### Workspace Proxies (enterprise) (premium)
### Workspace Proxies

<blockquote class="admonition tip">

Workspace proxies are an Enterprise and Premium feature.
[Learn more](https://coder.com/pricing#compare-plans).

</blockquote>

Workspace proxies are a Coder Enterprise feature that allows you to provide
low-latency browser experiences for geo-distributed teams.
Expand Down
9 changes: 8 additions & 1 deletion docs/admin/networking/port-forwarding.md
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,14 @@ resource uses a different method of authentication and **is not impacted by the
template's maximum sharing level**, nor the level of a shared port that points
to the app.

### Configure maximum port sharing level (enterprise) (premium)
### Configure maximum port sharing level

<blockquote class="admonition tip">

Configuring port sharing level is an Enterprise and Premium feature.
[Learn more](https://coder.com/pricing#compare-plans).

</blockquote>

Premium-licensed template admins can control the maximum port sharing level for
workspaces under a given template in the template settings. By default, the
Expand Down
9 changes: 8 additions & 1 deletion docs/admin/templates/managing-templates/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,14 @@ infrastructure, software, or security patches. Learn more about

![Updating a template](../../../images/templates/update.png)

### Template update policies (enterprise) (premium)
### Template update policies

<blockquote class="admonition tip">

Template update policies are an Enterprise and Premium feature.
[Learn more](https://coder.com/pricing#compare-plans).

</blockquote>

Licensed template admins may want workspaces to always remain on the latest
version of their parent template. To do so, enable **Template Update Policies**
Expand Down
45 changes: 40 additions & 5 deletions docs/admin/templates/managing-templates/schedule.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,13 +27,27 @@ allow users to define their own autostart and autostop schedules. Admins can
restrict the days of the week a workspace should automatically start to help
manage infrastructure costs.

## Failure cleanup (enterprise) (premium)
## Failure cleanup

<blockquote class="admonition tip">

Failure cleanup is an Enterprise and Premium feature.
[Learn more](https://coder.com/pricing#compare-plans).

</blockquote>

Failure cleanup defines how long a workspace is permitted to remain in the
failed state prior to being automatically stopped. Failure cleanup is only
available for licensed customers.

## Dormancy threshold (enterprise) (premium)
## Dormancy threshold

<blockquote class="admonition tip">

Dormancy threshold is an Enterprise and Premium feature.
[Learn more](https://coder.com/pricing#compare-plans).

</blockquote>

Dormancy Threshold defines how long Coder allows a workspace to remain inactive
before being moved into a dormant state. A workspace's inactivity is determined
Expand All @@ -43,13 +57,27 @@ the user before being accessible. Coder stops workspaces during their transition
to the dormant state if they are detected to be running. Dormancy Threshold is
only available for licensed customers.

## Dormancy auto-deletion (enterprise) (premium)
## Dormancy auto-deletion

<blockquote class="admonition tip">

Dormancy auto-deletion is an Enterprise and Premium feature.
[Learn more](https://coder.com/pricing#compare-plans).

</blockquote>

Dormancy Auto-Deletion allows a template admin to dictate how long a workspace
is permitted to remain dormant before it is automatically deleted. Dormancy
Auto-Deletion is only available for licensed customers.

## Autostop requirement (enterprise) (premium)
## Autostop requirement

<blockquote class="admonition tip">

Autostop requirement is an Enterprise and Premium feature.
[Learn more](https://coder.com/pricing#compare-plans).

</blockquote>

Autostop requirement is a template setting that determines how often workspaces
using the template must automatically stop. Autostop requirement ignores any
Expand Down Expand Up @@ -79,7 +107,14 @@ Autostop requirement is disabled when the template is using the deprecated max
lifetime feature. Templates can choose to use a max lifetime or an autostop
requirement during the deprecation period, but only one can be used at a time.

## User quiet hours (enterprise) (premium)
## User quiet hours

<blockquote class="admonition tip">

User quiet hours are an Enterprise and Premium feature.
[Learn more](https://coder.com/pricing#compare-plans).

</blockquote>

User quiet hours can be configured in the user's schedule settings page.
Workspaces on templates with an autostop requirement will only be forcibly
Expand Down
9 changes: 8 additions & 1 deletion docs/admin/users/groups-roles.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,14 @@ Roles determine which actions users can take within the platform.
A user may have one or more roles. All users have an implicit Member role that
may use personal workspaces.

## Custom Roles (Premium) (Beta)
## Custom Roles

<blockquote class="admonition tip">

Custom roles are an Enterprise and Premium feature.
[Learn more](https://coder.com/pricing#compare-plans).

</blockquote>

Starting in v2.16.0, Premium Coder deployments can configure custom roles on the
[Organization](./organizations.md) level. You can create and assign custom roles
Expand Down
18 changes: 16 additions & 2 deletions docs/admin/users/idp-sync.md
Original file line number Diff line number Diff line change
Expand Up @@ -184,7 +184,14 @@ Users who are not in a matching group will see the following error:

![Unauthorized group error](../../images/admin/group-allowlist.png)

## Role sync (enterprise) (premium)
## Role sync

<blockquote class="admonition tip">

Role sync is an Enterprise and Premium feature.
[Learn more](https://coder.com/pricing#compare-plans).

</blockquote>

If your OpenID Connect provider supports roles claims, you can configure Coder
to synchronize roles in your auth provider to roles within Coder.
Expand Down Expand Up @@ -302,7 +309,14 @@ Visit the Coder UI to confirm these changes:

</div>

## Organization Sync (Premium)
## Organization Sync

<blockquote class="admonition tip">

Organization sync is an Enterprise and Premium feature.
[Learn more](https://coder.com/pricing#compare-plans).

</blockquote>

> Note: In a future Coder release, this can be managed via the Coder UI instead
> of server flags.
Expand Down
9 changes: 8 additions & 1 deletion docs/admin/users/oidc-auth.md
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,14 @@ your Coder deployment:
CODER_DISABLE_PASSWORD_AUTH=true
```

## SCIM (enterprise) (premium)
## SCIM

<blockquote class="admonition tip">

SCIM is an Enterprise and Premium feature.
[Learn more](https://coder.com/pricing#compare-plans).

</blockquote>

Coder supports user provisioning and deprovisioning via SCIM 2.0 with header
authentication. Upon deactivation, users are
Expand Down
9 changes: 8 additions & 1 deletion docs/user-guides/workspace-management.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,14 @@ manually updated the workspace.

![Automatic Updates](../images/workspace-automatic-updates.png)

## Bulk operations (enterprise) (premium)
## Bulk operations

<blockquote class="admonition tip">

Bulk operations are an Enterprise and Premium feature.
[Learn more](https://coder.com/pricing#compare-plans).

</blockquote>

Licensed admins may apply bulk operations (update, delete, start, stop) in the
**Workspaces** tab. Select the workspaces you'd like to modify with the
Expand Down
27 changes: 24 additions & 3 deletions docs/user-guides/workspace-scheduling.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,14 @@ Workspaces will automatically shut down after a period of inactivity. This can
be configured at the template level, but is visible in the autostop description
for your workspace.

## Autostop requirement (enterprise) (premium)
## Autostop requirement

<blockquote class="admonition tip">

Autostop requirement is an Enterprise and Premium feature.
[Learn more](https://coder.com/pricing#compare-plans).

</blockquote>

Licensed template admins may enforce a required stop for workspaces to apply
updates or undergo maintenance. These stops ignore any active connections or
Expand All @@ -61,7 +68,14 @@ and specified quiet hours (see below).
> Admins: See the template schedule settings for more information on configuring
> Autostop Requirement.

### User quiet hours (enterprise) (premium)
### User quiet hours

<blockquote class="admonition tip">

User quiet hours are an Enterprise and Premium feature.
[Learn more](https://coder.com/pricing#compare-plans).

</blockquote>

User quiet hours can be configured in the user's schedule settings page.
Workspaces on templates with an autostop requirement will only be forcibly
Expand Down Expand Up @@ -99,7 +113,14 @@ Let's say that both are set to 5 hours. When either your workspace autostarts or
you sign in, you will have confidence that the only condition for shutdown is 5
hours of inactivity.

## Dormancy (enterprise) (premium)
## Dormancy

<blockquote class="admonition tip">

Dormancy is an Enterprise and Premium feature.
[Learn more](https://coder.com/pricing#compare-plans).

</blockquote>

Dormancy automatically deletes workspaces which remain unused for long
durations. Template admins configure an inactivity period after which your
Expand Down
Loading