chore: update images in appearance docs and correct inconsistencies (#11346)

* chore: update images in appearance docs and correct inconsistencies

* fix: spelling

---------

Co-authored-by: Eric <ericpaulsen@coder.com>
This commit is contained in:
sharkymark 2023-12-28 15:06:54 -06:00 committed by GitHub
parent 6fcc49f030
commit 3582284977
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
7 changed files with 41 additions and 12 deletions

View File

@ -1,4 +1,43 @@
# Appearance
# Appearance (enterprise)
Customize the look of your Coder deployment to meet your enterprise
requirements.
You can access the Appearance settings by navigating to
`Deployment > Appearance`.
![application name and logo url](../images/admin/application-name-logo-url.png)
## Application Name
Specify a custom application name to be displayed on the login page. The default
is Coder.
## Logo URL
Specify a custom URL for your enterprise's logo to be displayed in the top left
corner of the dashboard. The default is the Coder logo.
## Service Banner
![service banner](../images/admin/service-banner-config.png)
A Service Banner lets admins post important messages to all site users. Only
Site Owners may set the service banner.
Example: Notify users of scheduled maintenance of the Coder deployment.
![service banner maintenance](../images/admin/service-banner-maintenance.png)
Example: Adhere to government network classification requirements and notify
users of which network their Coder deployment is on.
![service banner secret](../images/admin/service-banner-secret.png)
## OIDC Login Button Customization
[Use environment variables to customize](../auth#oidc-login-customization) the
text and icon on the OIDC button on the Sign In page.
## Support Links
@ -24,20 +63,10 @@ supportLinks:
icon: "chat"
```
## Icons
### Icons
The link icons are optional, and limited to: `bug`, `chat`, and `docs`.
## Service Banners (enterprise)
Service Banners let admins post important messages to all site users. Only Site
Owners may set the service banner.
![service banners](../images/admin/service-banners.png)
You can access the Service Banner settings by navigating to
`Deployment > Service Banners`.
## Up next
- [Enterprise](../enterprise.md)

Binary file not shown.

After

Width:  |  Height:  |  Size: 248 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 133 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 150 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 134 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 370 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 16 KiB

After

Width:  |  Height:  |  Size: 67 KiB