[2022-12-12]: Enterprise customers can create custom banner messages - [GA] (#30523)

Co-authored-by: github-actions <github-actions@github.com>
Co-authored-by: Laura Coursen <lecoursen@github.com>
Co-authored-by: Matt Pollard <mattpollard@users.noreply.github.com>
This commit is contained in:
Sophie 2023-01-03 19:12:08 +01:00 коммит произвёл GitHub
Родитель d329ac7fe9
Коммит 56f9e5a63c
Не найден ключ, соответствующий данной подписи
Идентификатор ключа GPG: 4AEE18F83AFDEB23
9 изменённых файлов: 81 добавлений и 19 удалений

Двоичный файл не отображается.

После

Ширина:  |  Высота:  |  Размер: 12 KiB

Двоичный файл не отображается.

После

Ширина:  |  Высота:  |  Размер: 37 KiB

Двоичный файл не отображается.

После

Ширина:  |  Высота:  |  Размер: 14 KiB

Просмотреть файл

@ -8,6 +8,7 @@ redirect_from:
- /admin/user-management/customizing-user-messages-for-your-enterprise
intro: 'You can create custom messages that users will see on {% data variables.location.product_location %}.'
versions:
ghec: '*'
ghes: '*'
ghae: '*'
type: how_to
@ -17,10 +18,16 @@ topics:
---
## About user messages
{% ifversion ghec %}
You can create global announcement banners, which appear at the top of every page.
{% data reusables.enterprise.user-messages-markdown %}
{% else %}
There are several types of user messages.
- Messages that appear on the {% ifversion ghes %}sign in or {% endif %}sign out page{% ifversion ghes or ghae %}
- Mandatory messages, which appear once in a pop-up window that must be dismissed{% endif %}{% ifversion ghes or ghae %}
- Announcement banners, which appear at the top of every page{% endif %}
- Announcement banners, which appear at the top of every page{% endif %}{% endif %}
{% ifversion ghes %}
{% note %}
@ -29,7 +36,7 @@ There are several types of user messages.
{% endnote %}
You can use Markdown to format your message. For more information, see "[About writing and formatting on {% data variables.product.prodname_dotcom %}](/articles/about-writing-and-formatting-on-github/)."
{% data reusables.enterprise.user-messages-markdown %}
## Creating a custom sign in message
@ -48,6 +55,8 @@ You can use Markdown to format your message. For more information, see "[About w
{% data reusables.enterprise_site_admin_settings.save-changes %}{% endif %}
{% endif %}
{% ifversion ghes or ghae %}
## Creating a custom sign out message
{% data reusables.enterprise-accounts.access-enterprise %}
@ -62,7 +71,7 @@ You can use Markdown to format your message. For more information, see "[About w
![Preview button](/assets/images/enterprise/site-admin-settings/sign-out-message-preview-button.png)
8. Review the rendered message.
![Sign out message rendered](/assets/images/enterprise/site-admin-settings/sign-out-message-rendered.png)
{% data reusables.enterprise_site_admin_settings.save-changes %}{% endif %}
{% data reusables.enterprise_site_admin_settings.save-changes %}{% endif %}{% endif %}
{% ifversion ghes or ghae %}
## Creating a mandatory message
@ -102,30 +111,39 @@ Each time a user sees a mandatory message, an audit log event is created. The ev
{% endif %}
{% ifversion ghes or ghae %}
## Creating a global announcement banner
You can set a global announcement banner to be displayed to all users at the top of every page.
You can set a global announcement banner to be displayed to all users at the top of every page{% ifversion ghec %} within your enterprise{% endif %}.
{% ifversion custom-banner-messages %}
You can also create announcement banners at the organization level. For more information, see "[Creating an announcement banner for your organization](/organizations/managing-organization-settings/creating-an-announcement-banner-for-your-organization)."{% endif %}
{% ifversion ghae or ghes %}
You can also set an announcement banner{% ifversion ghes %} in the administrative shell using a command line utility or{% endif %} using the API. For more information, see {% ifversion ghes %}"[Command-line utilities](/enterprise/admin/configuration/command-line-utilities#ghe-announce)" and {% endif %}"[{% data variables.product.prodname_enterprise %} administration](/rest/reference/enterprise-admin#announcements)."
{% else %}
You can also set an announcement banner in the administrative shell using a command line utility. For more information, see "[Command-line utilities](/enterprise/admin/configuration/command-line-utilities#ghe-announce)."
{% endif %}
{% data reusables.enterprise-accounts.access-enterprise %}
{% data reusables.enterprise-accounts.settings-tab %}
{% data reusables.enterprise-accounts.messages-tab %}
1. {% ifversion ghes or ghae %}To the right of{% else %}Under{% endif %} "Announcement", click **Add announcement**.
![Add announcement button](/assets/images/enterprise/site-admin-settings/add-announcement-button.png)
{% data reusables.enterprise-accounts.messages-tab %}{% ifversion custom-banner-messages %}{% else %}
1. To the right of "Announcement", click **Add announcement**.
![Screenshot of the add announcement button](/assets/images/enterprise/site-admin-settings/add-announcement-button.png){% endif %}
1. Under "Announcement", in the text field, type the announcement you want displayed in a banner.
![Text field to enter announcement](/assets/images/enterprise/site-admin-settings/announcement-text-field.png)
1. Optionally, under "Expires on", select the calendar drop-down menu and click an expiration date.
![Calendar drop-down menu to choose expiration date](/assets/images/enterprise/site-admin-settings/expiration-drop-down.png){% ifversion ghe-announce-dismiss %}
1. Optionally, to allow each user to dismiss the announcement, select **User dismissible**.
![Screenshot of the "User dismissible" checkbox](/assets/images/enterprise/site-admin-settings/user-dismissible-checkbox.png){% endif %}
![Screenshot of the text field to enter announcement](/assets/images/enterprise/site-admin-settings/announcement-text-field.png)
2. Optionally, under "Expires on", select the calendar drop-down menu and click an expiration date.
{% note %}
**Note:** Announcements must either have an expiration date, be user dismissible, or both.
{% endnote %}
![Screenshot of the calendar drop-down menu to choose expiration date](/assets/images/enterprise/site-admin-settings/expiration-drop-down.png){% ifversion ghe-announce-dismiss %}
3. Optionally, to allow each user to dismiss the announcement, select **User dismissible**.
![Screenshot of the "User dismissible" checkbox](/assets/images/enterprise/site-admin-settings/user-dismissible-checkbox.png){% endif %}{% ifversion custom-banner-messages %}
4. Optionally, to allow each user to dismiss the announcement, select **Allow users to dismiss the announcement**.
![Screenshot of the "Allow users to dismiss the announcement" checkbox](/assets/images/enterprise/site-admin-settings/allow-users-to-dismiss-announcement.png){% endif %}
{% data reusables.enterprise_site_admin_settings.message-preview-save %}
{% endif %}

Просмотреть файл

@ -0,0 +1,36 @@
---
title: Creating an announcement banner for your organization
shortTitle: Create an announcement banner
intro: 'Organization owners can create announcement banners for the organization.'
versions:
feature: custom-banner-messages
type: how_to
topics:
- Maintenance
---
You can create an announcement banner that will be displayed to all organization members at the top of every page in the organization.
{% data reusables.enterprise.user-messages-markdown %}
You can also set announcement banners at the enterprise level. For more information, see "[Customizing user messages for your enterprise](/admin/user-management/managing-users-in-your-enterprise/customizing-user-messages-for-your-enterprise)."
{% data reusables.profile.access_org %}
{% data reusables.profile.org_settings %}
1. In the "Messages" section of the sidebar, click **{% octicon "megaphone" aria-label="The megaphone icon" %} Announcement**.
2. Under "Announcement", in the text field, type the announcement you want displayed in a banner.
![Screenshot of the text field to enter announcement](/assets/images/help/organizations/organization-announcement-text-field.png)
3. Optionally, under "Expires on", select the calendar drop-down menu and click an expiration date.
{% note %}
**Note:** Announcements must either have an expiration date, be user dismissible, or both.
{% endnote %}
![Screenshot of the calendar drop-down menu to choose expiration date](/assets/images/enterprise/site-admin-settings/expiration-drop-down.png)
4. Optionally, to allow each user to dismiss the announcement, select **Allow users to dismiss the announcement**.
![Screenshot of the "Allow users to dismiss the announcement" checkbox](/assets/images/enterprise/site-admin-settings/allow-users-to-dismiss-announcement.png)
{% data reusables.enterprise_site_admin_settings.message-preview-save %}

Просмотреть файл

@ -29,6 +29,7 @@ children:
- /managing-discussion-creation-for-repositories-in-your-organization
- /managing-the-commit-signoff-policy-for-your-organization
- /setting-team-creation-permissions-in-your-organization
- /creating-an-announcement-banner-for-your-organization
- /limiting-oauth-app-and-github-app-access-requests
- /managing-scheduled-reminders-for-your-organization
- /managing-the-default-branch-name-for-repositories-in-your-organization

Просмотреть файл

@ -22,4 +22,3 @@ children:
- /configuring-tag-protection-rules
shortTitle: Manage repository settings
---

Просмотреть файл

@ -0,0 +1,7 @@
# Reference: issue #7643
# Enterprise customers can create custom banner messages - [GA]
versions:
ghec: '*'
ghes: '>=3.9'
ghae: '>=3.9'

Просмотреть файл

@ -0,0 +1 @@
You can use Markdown to format your message. For more information, see "[About writing and formatting on {% data variables.product.prodname_dotcom %}](/articles/about-writing-and-formatting-on-github/)."