From 94be244a9fb5da7a8b5d5fb99e5760cde17715ac Mon Sep 17 00:00:00 2001 From: GitLab Bot Date: Tue, 15 Oct 2019 03:06:19 +0000 Subject: Add latest changes from gitlab-org/gitlab@master --- doc/customization/branded_login_page.md | 37 +------- .../branded_login_page/appearance.png | Bin 85263 -> 0 bytes .../branded_login_page/custom_sign_in.png | Bin 79276 -> 0 bytes .../branded_login_page/default_login_page.png | Bin 73004 -> 0 bytes doc/customization/branded_page_and_email_header.md | 36 +------- .../branded_page_and_email_header/appearance.png | Bin 5625 -> 0 bytes .../custom_brand_header.png | Bin 5279 -> 0 bytes .../custom_email_header.png | Bin 14671 -> 0 bytes doc/customization/favicon.md | 36 +------- doc/customization/favicon/appearance.png | Bin 28933 -> 0 bytes doc/customization/favicon/custom_favicon.png | Bin 31600 -> 0 bytes doc/customization/help_message.md | 35 +------- doc/customization/help_message/help_text.png | Bin 38521 -> 0 bytes .../help_message/help_text_on_help_page.png | Bin 24355 -> 0 bytes doc/customization/index.md | 17 +--- doc/customization/libravatar.md | 100 +-------------------- doc/customization/new_project_page.md | 37 +------- .../new_project_page/appearance_settings.png | Bin 30473 -> 0 bytes .../new_project_page/custom_new_project_page.png | Bin 69523 -> 0 bytes .../new_project_page/default_new_project_page.png | Bin 62717 -> 0 bytes .../system_header_and_footer_messages.md | 26 +----- .../appearance.png | Bin 32295 -> 0 bytes .../custom_header_footer.png | Bin 116778 -> 0 bytes .../sign_up_custom_header_and_footer.png | Bin 78678 -> 0 bytes 24 files changed, 18 insertions(+), 306 deletions(-) delete mode 100644 doc/customization/branded_login_page/appearance.png delete mode 100644 doc/customization/branded_login_page/custom_sign_in.png delete mode 100644 doc/customization/branded_login_page/default_login_page.png delete mode 100644 doc/customization/branded_page_and_email_header/appearance.png delete mode 100644 doc/customization/branded_page_and_email_header/custom_brand_header.png delete mode 100644 doc/customization/branded_page_and_email_header/custom_email_header.png delete mode 100644 doc/customization/favicon/appearance.png delete mode 100644 doc/customization/favicon/custom_favicon.png delete mode 100644 doc/customization/help_message/help_text.png delete mode 100644 doc/customization/help_message/help_text_on_help_page.png delete mode 100644 doc/customization/new_project_page/appearance_settings.png delete mode 100644 doc/customization/new_project_page/custom_new_project_page.png delete mode 100644 doc/customization/new_project_page/default_new_project_page.png delete mode 100644 doc/customization/system_header_and_footer_messages/appearance.png delete mode 100644 doc/customization/system_header_and_footer_messages/custom_header_footer.png delete mode 100644 doc/customization/system_header_and_footer_messages/sign_up_custom_header_and_footer.png (limited to 'doc/customization') diff --git a/doc/customization/branded_login_page.md b/doc/customization/branded_login_page.md index afcc2b71284..9667e5e380a 100644 --- a/doc/customization/branded_login_page.md +++ b/doc/customization/branded_login_page.md @@ -1,38 +1,5 @@ --- -type: howto +redirect_to: '../user/admin_area/appearance.md#sign-in--sign-up-pages' --- -# Changing the logo and description on the login page - -You can customize the login page of your GitLab server to show the logo and -description of your organization. - -By default, the page shows the GitLab logo and description: - -![default_login_page](branded_login_page/default_login_page.png) - -To customize the login page: - -1. Navigate to the **Admin** area and go to the **Appearance** page. -1. Fill in your desired Title and Description. You can also choose an image file - of the logo for your organization. - - ![appearance](branded_login_page/appearance.png) - -1. Save your changes. - -Your GitLab login page will display the details you provided: - -![company_login_page](branded_login_page/custom_sign_in.png) - - +This document was moved to [another location](../user/admin_area/appearance.md#sign-in--sign-up-pages). diff --git a/doc/customization/branded_login_page/appearance.png b/doc/customization/branded_login_page/appearance.png deleted file mode 100644 index 31ea4559d37..00000000000 Binary files a/doc/customization/branded_login_page/appearance.png and /dev/null differ diff --git a/doc/customization/branded_login_page/custom_sign_in.png b/doc/customization/branded_login_page/custom_sign_in.png deleted file mode 100644 index 03ea5281ebe..00000000000 Binary files a/doc/customization/branded_login_page/custom_sign_in.png and /dev/null differ diff --git a/doc/customization/branded_login_page/default_login_page.png b/doc/customization/branded_login_page/default_login_page.png deleted file mode 100644 index 9b1233cef45..00000000000 Binary files a/doc/customization/branded_login_page/default_login_page.png and /dev/null differ diff --git a/doc/customization/branded_page_and_email_header.md b/doc/customization/branded_page_and_email_header.md index 370c1461d30..64958521f64 100644 --- a/doc/customization/branded_page_and_email_header.md +++ b/doc/customization/branded_page_and_email_header.md @@ -1,37 +1,5 @@ --- -type: howto +redirect_to: '../user/admin_area/appearance.md#navigation-bar' --- -# Changing the navigation bar and email header logo - -You can customize the logo that appears in email headers and in the navigation -bar on pages that are displayed by your GitLab server. - -1. Navigate to the **Admin** area and go to the **Appearance** page, then locate - the **Navigation bar** section. -1. For the **Header Logo**, choose an image file of the logo for your - organization. - - ![appearance](branded_page_and_email_header/appearance.png) - -1. Save your changes. - -Your GitLab navigation bar will display the custom logo: - -![custom_brand_header](branded_page_and_email_header/custom_brand_header.png) - -The GitLab pipeline emails will also display the custom logo: - -![custom_email_header](branded_page_and_email_header/custom_email_header.png) - - +This document was moved to [another location](../user/admin_area/appearance.md#navigation-bar). diff --git a/doc/customization/branded_page_and_email_header/appearance.png b/doc/customization/branded_page_and_email_header/appearance.png deleted file mode 100644 index 6b79bc47005..00000000000 Binary files a/doc/customization/branded_page_and_email_header/appearance.png and /dev/null differ diff --git a/doc/customization/branded_page_and_email_header/custom_brand_header.png b/doc/customization/branded_page_and_email_header/custom_brand_header.png deleted file mode 100644 index d779236bbe7..00000000000 Binary files a/doc/customization/branded_page_and_email_header/custom_brand_header.png and /dev/null differ diff --git a/doc/customization/branded_page_and_email_header/custom_email_header.png b/doc/customization/branded_page_and_email_header/custom_email_header.png deleted file mode 100644 index 729b166364b..00000000000 Binary files a/doc/customization/branded_page_and_email_header/custom_email_header.png and /dev/null differ diff --git a/doc/customization/favicon.md b/doc/customization/favicon.md index e165a16ffd9..d43ed944e26 100644 --- a/doc/customization/favicon.md +++ b/doc/customization/favicon.md @@ -1,37 +1,5 @@ --- -type: howto +redirect_to: '../user/admin_area/appearance.md#favicon' --- -# Changing the favicon - -> [Introduced][ce-14497] in GitLab 11.0. - -[ce-14497]: https://gitlab.com/gitlab-org/gitlab-foss/merge_requests/14497 - -You can customize the favicon (the icon displayed in your web browser's -address bar and web page tabs) for your GitLab server. - -1. Navigate to the **Admin** area and go to the **Appearance** page, then - locate the **Favicon** section. -1. Upload an image file of your favicon. - - ![appearance](favicon/appearance.png) - -1. Save your changes. - -Your new favicon will display in the browser. The main favicon and the CI -status icons will show the custom icon: - -![custom_favicon](favicon/custom_favicon.png) - - +This document was moved to [another location](../user/admin_area/appearance.md#favicon). diff --git a/doc/customization/favicon/appearance.png b/doc/customization/favicon/appearance.png deleted file mode 100644 index da1002826dd..00000000000 Binary files a/doc/customization/favicon/appearance.png and /dev/null differ diff --git a/doc/customization/favicon/custom_favicon.png b/doc/customization/favicon/custom_favicon.png deleted file mode 100644 index 20dddfbea33..00000000000 Binary files a/doc/customization/favicon/custom_favicon.png and /dev/null differ diff --git a/doc/customization/help_message.md b/doc/customization/help_message.md index a4d8f295750..5694ee89c17 100644 --- a/doc/customization/help_message.md +++ b/doc/customization/help_message.md @@ -1,36 +1,5 @@ --- -type: howto +redirect_to: '../user/admin_area/settings/help_page.md' --- -# Customizing the 'Help' and login page messages - -In large organizations, it is useful to have information about who maintains -the company GitLab server. You can customize and display this information on -the GitLab login page and on the GitLab server's `/help` page. - -1. Navigate to the **Admin** area, then click on **Preferences** and expand - **Help page**. -1. Under **Help page text**, fill in the required information about the - person(s) administering GitLab. This text can also contain any other - information that you wish to display to users. - - ![help message](help_message/help_text.png) - -1. Save your changes. - -The information you entered will be shown on the GitLab login page and on the -GitLab `/help` page (e.g., ). - -![help text on help page](help_message/help_text_on_help_page.png) - - +This document was moved to [another location](../user/admin_area/settings/help_page.md). diff --git a/doc/customization/help_message/help_text.png b/doc/customization/help_message/help_text.png deleted file mode 100644 index 5fcabcdb757..00000000000 Binary files a/doc/customization/help_message/help_text.png and /dev/null differ diff --git a/doc/customization/help_message/help_text_on_help_page.png b/doc/customization/help_message/help_text_on_help_page.png deleted file mode 100644 index 288b4b8c1eb..00000000000 Binary files a/doc/customization/help_message/help_text_on_help_page.png and /dev/null differ diff --git a/doc/customization/index.md b/doc/customization/index.md index f17a2d80e2c..f3e1e3190fd 100644 --- a/doc/customization/index.md +++ b/doc/customization/index.md @@ -1,18 +1,5 @@ --- -type: index -description: Learn how to customize GitLab's appearance for self-managed installations. +redirect_to: '../user/admin_area/appearance.md' --- -# Customizing GitLab's appearance **(CORE ONLY)** - -For GitLab self-managed instances, you can customize the page logo, -email headers, favicon, and several other aspects of GitLab's appearance. - -The following pages explain how to customize the appearance of your instance: - -- [Changing the logo and description on the login page](branded_login_page.md) -- [Changing the navigation bar and email header logo](branded_page_and_email_header.md) -- [Changing the favicon](favicon.md) -- [Customizing the new project page](new_project_page.md) -- [Customizing the `/help` and login page messages](help_message.md) -- [Using the Libravatar service with GitLab](libravatar.md) +This document was moved to [another location](../user/admin_area/appearance.md). diff --git a/doc/customization/libravatar.md b/doc/customization/libravatar.md index 43a6b8f0d34..78df24066ea 100644 --- a/doc/customization/libravatar.md +++ b/doc/customization/libravatar.md @@ -1,101 +1,5 @@ --- -type: howto +redirect_to: '../administration/libravatar.md' --- -# Using the Libravatar service with GitLab - -GitLab by default supports the [Gravatar](https://gravatar.com) avatar service. - -Libravatar is another service that delivers your avatar (profile picture) to -other websites. The Libravatar API is -[heavily based on gravatar](https://wiki.libravatar.org/api/), so you can -easily switch to the Libravatar avatar service or even a self-hosted Libravatar -server. - -## Configuration - -In the [`gitlab.yml` gravatar section](https://gitlab.com/gitlab-org/gitlab/blob/672bd3902d86b78d730cea809fce312ec49d39d7/config/gitlab.yml.example#L122), set -the configuration options as follows: - -### For HTTP - -```yml - gravatar: - enabled: true - # gravatar URLs: possible placeholders: %{hash} %{size} %{email} %{username} - plain_url: "http://cdn.libravatar.org/avatar/%{hash}?s=%{size}&d=identicon" -``` - -### For HTTPS - -```yml - gravatar: - enabled: true - # gravatar URLs: possible placeholders: %{hash} %{size} %{email} %{username} - ssl_url: "https://seccdn.libravatar.org/avatar/%{hash}?s=%{size}&d=identicon" -``` - -### Self-hosted Libravatar server - -If you are [running your own libravatar service](https://wiki.libravatar.org/running_your_own/), -the URL will be different in the configuration, but you must provide the same -placeholders so GitLab can parse the URL correctly. - -For example, you host a service on `http://libravatar.example.com` and the -`plain_url` you need to supply in `gitlab.yml` is - -`http://libravatar.example.com/avatar/%{hash}?s=%{size}&d=identicon` - -### Omnibus GitLab example - -In `/etc/gitlab/gitlab.rb`: - -#### For HTTP - -```ruby -gitlab_rails['gravatar_enabled'] = true -gitlab_rails['gravatar_plain_url'] = "http://cdn.libravatar.org/avatar/%{hash}?s=%{size}&d=identicon" -``` - -#### For HTTPS - -```ruby -gitlab_rails['gravatar_enabled'] = true -gitlab_rails['gravatar_ssl_url'] = "https://seccdn.libravatar.org/avatar/%{hash}?s=%{size}&d=identicon" -``` - -Then run `sudo gitlab-ctl reconfigure` for the changes to take effect. - -## Default URL for missing images - -[Libravatar supports different sets](https://wiki.libravatar.org/api/) of -missing images for user email addresses that are not found on the Libravatar -service. - -In order to use a set other than `identicon`, replace the `&d=identicon` -portion of the URL with another supported set. -For example, you can use the `retro` set, in which case the URL would look like: -`plain_url: "http://cdn.libravatar.org/avatar/%{hash}?s=%{size}&d=retro"` - -## Usage examples for Microsoft Office 365 - -If your users are Office 365 users, the `GetPersonaPhoto` service can be used. -Note that this service requires a login, so this use case is most useful in a -corporate installation where all users have access to Office 365. - -```ruby -gitlab_rails['gravatar_plain_url'] = 'http://outlook.office365.com/owa/service.svc/s/GetPersonaPhoto?email=%{email}&size=HR120x120' -gitlab_rails['gravatar_ssl_url'] = 'https://outlook.office365.com/owa/service.svc/s/GetPersonaPhoto?email=%{email}&size=HR120x120' -``` - - +This document was moved to [another location](../administration/libravatar.md). diff --git a/doc/customization/new_project_page.md b/doc/customization/new_project_page.md index 43b95a76d08..ee09df26cb1 100644 --- a/doc/customization/new_project_page.md +++ b/doc/customization/new_project_page.md @@ -1,38 +1,5 @@ --- -type: howto +redirect_to: '../user/admin_area/appearance.md#new-project-pages' --- -# Customizing the new project page - -You can add a markdown-formatted message to your GitLab new project page. - -By default, the new project page shows a sidebar with general information: - -![default_new_project_page](new_project_page/default_new_project_page.png) - -To customize the information in the sidebar: - -1. Navigate to the **Admin** area and go to the **Appearance** page, then - locate the **New project pages** section. -1. Fill in your new project project guidelines: - - ![appearance_settings](new_project_page/appearance_settings.png) - -1. Save the page. - -Your new project page will show the customized guidelines in the sidebar, below -the general information: - -![custom_new_project_page](new_project_page/custom_new_project_page.png) - - +This document was moved to [another location](../user/admin_area/appearance.md#new-project-pages). diff --git a/doc/customization/new_project_page/appearance_settings.png b/doc/customization/new_project_page/appearance_settings.png deleted file mode 100644 index 4fcdd1caa21..00000000000 Binary files a/doc/customization/new_project_page/appearance_settings.png and /dev/null differ diff --git a/doc/customization/new_project_page/custom_new_project_page.png b/doc/customization/new_project_page/custom_new_project_page.png deleted file mode 100644 index c6f7839e9c3..00000000000 Binary files a/doc/customization/new_project_page/custom_new_project_page.png and /dev/null differ diff --git a/doc/customization/new_project_page/default_new_project_page.png b/doc/customization/new_project_page/default_new_project_page.png deleted file mode 100644 index f5b209ac5ea..00000000000 Binary files a/doc/customization/new_project_page/default_new_project_page.png and /dev/null differ diff --git a/doc/customization/system_header_and_footer_messages.md b/doc/customization/system_header_and_footer_messages.md index 5db971d0c1e..1d17f3bee3f 100644 --- a/doc/customization/system_header_and_footer_messages.md +++ b/doc/customization/system_header_and_footer_messages.md @@ -1,23 +1,5 @@ -# Adding a system message to every page +--- +redirect_to: '../user/admin_area/appearance.md#system-header-and-footer-messages' +--- -> [Introduced](https://gitlab.com/gitlab-org/gitlab/issues/5023) in [GitLab Premium](https://about.gitlab.com/pricing/) 10.7. -> [Added](https://gitlab.com/gitlab-org/gitlab-foss/issues/55057) to [GitLab Core](https://about.gitlab.com/pricing/) in 11.9. - -Navigate to the **Admin** area and go to the **Appearance** page. - -Under **System header and footer** insert your header message and/or footer message. -Both background and font color of the header and footer are customizable. - -You can also apply the header and footer messages to GitLab emails, -by checking the **Enable header and footer in emails** checkbox. -Note that color settings will only be applied within the app interface and not to emails - -![appearance](system_header_and_footer_messages/appearance.png) - -After saving, all pages within GitLab will contain the custom system header and/or footer messages: - -![custom_header_footer](system_header_and_footer_messages/custom_header_footer.png) - -The GitLab sign in page will also show the header and the footer messages: - -![sign_up_custom_header_and_footer](system_header_and_footer_messages/sign_up_custom_header_and_footer.png) +This document was moved to [another location](../user/admin_area/appearance.md#system-header-and-footer-messages). diff --git a/doc/customization/system_header_and_footer_messages/appearance.png b/doc/customization/system_header_and_footer_messages/appearance.png deleted file mode 100644 index d5a66bcb9f1..00000000000 Binary files a/doc/customization/system_header_and_footer_messages/appearance.png and /dev/null differ diff --git a/doc/customization/system_header_and_footer_messages/custom_header_footer.png b/doc/customization/system_header_and_footer_messages/custom_header_footer.png deleted file mode 100644 index 15d19c87dd7..00000000000 Binary files a/doc/customization/system_header_and_footer_messages/custom_header_footer.png and /dev/null differ diff --git a/doc/customization/system_header_and_footer_messages/sign_up_custom_header_and_footer.png b/doc/customization/system_header_and_footer_messages/sign_up_custom_header_and_footer.png deleted file mode 100644 index 51349ddf6f4..00000000000 Binary files a/doc/customization/system_header_and_footer_messages/sign_up_custom_header_and_footer.png and /dev/null differ -- cgit v1.2.1