gitlab-org--gitlab-foss/doc/user/admin_area/settings/help_page.md

2.2 KiB

stage group info type
none unassigned To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments howto

Customizing the 'Help' and login page messages

In large organizations, it is useful to have information about who to contact or where to go for help. You can customize and display this information on the GitLab server's /help page and on the GitLab login page.

Adding a help message to the help page

You can add a help message, which is shown on the GitLab /help page (e.g., https://gitlab.com/help) in a new section at the top of the /help page:

  1. Navigate to Admin Area > Settings > Preferences, then expand Help page.

  2. Under Help page text, fill in the information you wish to display on /help.

    help page help message

  3. Save your changes. You can now see the message on /help.

help message on help page example

Adding a help message to the login page (STARTER)

You can add a help message, which is shown on the GitLab login page in a new section titled Need Help?, located below the login page message:

  1. Navigate to Admin Area > Settings > Preferences, then expand Help page.

  2. Under Help text, fill in the information you wish to display on the login page.

    help message on login page

  3. Save your changes.

help message on login page example