realaravinth/debian-mirror-gitlab
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
debian-mirror-gitlab/doc/user/admin_area/settings/help_page.md
Mohammed Bilal 8ec612e4e8
New upstream version 15.6.4+ds1
2023-01-13 15:02:22 +05:30

4.6 KiB
Raw Blame History

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/product/ux/technical-writing/#assignments howto

Customize the Help and sign-in page messages (FREE SELF)

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 /help page and on the GitLab sign-in page.

Add a help message to the Help page

You can add a help message, which is shown at the top of the GitLab /help page (for example, https://gitlab.com/help):

  1. On the top bar, select Main menu > Admin.
  2. On the left sidebar, select Settings > Preferences.
  3. Expand Sign-in and Help page.
  4. In Additional text to show on the Help page, enter the information you want to display on /help.
  5. Select Save changes.

You can now see the message on /help.

NOTE: By default, /help is visible to unauthenticated users. However, if the Public visibility level is restricted, /help is visible only to signed-in users.

Add a help message to the sign-in page

You can add a help message, which is shown on the GitLab sign-in page. The message appears on the sign-in page:

  1. On the top bar, select Main menu > Admin.
  2. On the left sidebar, select Settings > Preferences.
  3. Expand Sign-in and Help page.
  4. In Additional text to show on the sign-in page, enter the information you want to display on the sign-in page.
  5. Select Save changes.

You can now see the message on the sign-in page.

Hide marketing-related entries from the Help page

GitLab marketing-related entries are occasionally shown on the Help page. To hide these entries:

  1. On the top bar, select Main menu > Admin.
  2. On the left sidebar, select Settings > Preferences.
  3. Expand Sign-in and Help page.
  4. Select the Hide marketing-related entries from the Help page checkbox.
  5. Select Save changes.

Set a custom Support page URL

You can specify a custom URL to which users are directed when they:

  • Select Support from the Help dropdown list.
  • Select See our website for help on the Help page.
  1. On the top bar, select Main menu > Admin.
  2. On the left sidebar, select Settings > Preferences.
  3. Expand Sign-in and Help page.
  4. In the Support page URL field, enter the URL.
  5. Select Save changes.

Redirect /help pages

The /help URL of a GitLab instance displays a basic version of the documentation sourced from the doc directory of GitLab. /help links are often used for contextual help.

You can redirect these /help links to either:

  1. On the top bar, select Main menu > Admin.
  2. On the left sidebar, select Settings > Preferences.
  3. Expand Sign-in and Help page.
  4. In the Documentation pages URL field, enter the URL.
  5. Select Save changes.

Destination requirements

When redirecting /help, GitLab:

  • Redirects requests to the specified URL.
  • Appends ee and the documentation path to the URL.
  • Appends .html to the URL, and removes .md if necessary.

For example, if the URL is set to https://docs.gitlab.com, requests for /help/user/admin_area/settings/help_page.md redirect to: https://docs.gitlab.com/ee/user/admin_area/settings/help_page.html.