diff options
-rw-r--r-- | app/assets/javascripts/monitoring/utils.js | 2 | ||||
-rw-r--r-- | doc/administration/index.md | 11 | ||||
-rw-r--r-- | doc/development/README.md | 2 | ||||
-rw-r--r-- | doc/development/utilities.md | 34 | ||||
-rw-r--r-- | doc/install/installation.md | 2 | ||||
-rw-r--r-- | doc/user/admin_area/settings/email.md | 2 |
6 files changed, 26 insertions, 27 deletions
diff --git a/app/assets/javascripts/monitoring/utils.js b/app/assets/javascripts/monitoring/utils.js index 4c72f5226b7..00f188c1d5a 100644 --- a/app/assets/javascripts/monitoring/utils.js +++ b/app/assets/javascripts/monitoring/utils.js @@ -41,7 +41,7 @@ export const isValidDate = dateString => { return true; } return false; - } catch { + } catch (e) { return false; } }; diff --git a/doc/administration/index.md b/doc/administration/index.md index f90b9b2c7d5..e0f8ab8d855 100644 --- a/doc/administration/index.md +++ b/doc/administration/index.md @@ -68,11 +68,10 @@ Learn how to install, configure, update, and maintain your GitLab instance. #### Customizing GitLab's appearance -- [Header logo](../customization/branded_page_and_email_header.md): Change the logo on all pages and email headers. -- [Favicon](../customization/favicon.md): Change the default favicon to your own logo. -- [Branded login page](../customization/branded_login_page.md): Customize the login page with your own logo, title, and description. -- [Welcome message](../customization/welcome_message.md): Add a custom welcome message to the sign-in page. -- ["New Project" page](../customization/new_project_page.md): Customize the text to be displayed on the page that opens whenever your users create a new project. +- [Header logo](../user/admin_area/appearance.md#navigation-bar): Change the logo on all pages and email headers. +- [Favicon](../user/admin_area/appearance.md#favicon): Change the default favicon to your own logo. +- [Branded login page](../user/admin_area/appearance.md#sign-in--sign-up-pages): Customize the login page with your own logo, title, and description. +- ["New Project" page](../user/admin_area/appearance.md#new-project-pages): Customize the text to be displayed on the page that opens whenever your users create a new project. - [Additional custom email text](../user/admin_area/settings/email.md#custom-additional-text-premium-only): Add additional custom text to emails sent from GitLab. **(PREMIUM ONLY)** ### Maintaining GitLab @@ -105,7 +104,7 @@ Learn how to install, configure, update, and maintain your GitLab instance. ## User settings and permissions - [Creating users](../user/profile/account/create_accounts.md): Create users manually or through authentication integrations. -- [Libravatar](../customization/libravatar.md): Use Libravatar instead of Gravatar for user avatars. +- [Libravatar](libravatar.md): Use Libravatar instead of Gravatar for user avatars. - [Sign-up restrictions](../user/admin_area/settings/sign_up_restrictions.md): block email addresses of specific domains, or whitelist only specific domains. - [Access restrictions](../user/admin_area/settings/visibility_and_access_controls.md#enabled-git-access-protocols): Define which Git access protocols can be used to talk to GitLab (SSH, HTTP, HTTPS). - [Authentication and Authorization](auth/README.md): Configure external authentication with LDAP, SAML, CAS and additional providers. diff --git a/doc/development/README.md b/doc/development/README.md index 16b073045cc..e3ec460a6fe 100644 --- a/doc/development/README.md +++ b/doc/development/README.md @@ -99,7 +99,7 @@ description: 'Learn how to contribute to GitLab.' - [Post deployment migrations](post_deployment_migrations.md) - [Background migrations](background_migrations.md) - [Swapping tables](swapping_tables.md) -- [Deleting exiting migrations](deleting_migrations.md) +- [Deleting migrations](deleting_migrations.md) ### Best practices diff --git a/doc/development/utilities.md b/doc/development/utilities.md index 38e416d68e4..a5f6fec4cd8 100644 --- a/doc/development/utilities.md +++ b/doc/development/utilities.md @@ -1,6 +1,6 @@ # GitLab utilities -We developed a number of utilities to ease development. +We have developed a number of utilities to help ease development: ## `MergeHash` @@ -51,15 +51,15 @@ Refer to: <https://gitlab.com/gitlab-org/gitlab/blob/master/lib/gitlab/utils/mer Refer to <https://gitlab.com/gitlab-org/gitlab/blob/master/lib/gitlab/utils/override.rb>: -- This utility could help us check if a particular method would override - another method or not. It has the same idea of Java's `@Override` annotation - or Scala's `override` keyword. However we only do this check when +- This utility can help you check if one method would override + another or not. It is the same concept as Java's `@Override` annotation + or Scala's `override` keyword. However, you should only do this check when `ENV['STATIC_VERIFICATION']` is set to avoid production runtime overhead. - This is useful to check: + This is useful for checking: - - If we have typos in overriding methods. - - If we renamed the overridden methods, making original overriding methods - overrides nothing. + - If you have typos in overriding methods. + - If you renamed the overridden methods, which make the original override methods + irrelevant. Here's a simple example: @@ -100,11 +100,11 @@ Refer to <https://gitlab.com/gitlab-org/gitlab/blob/master/lib/gitlab/utils/stro - Memoize the value even if it is `nil` or `false`. - We often do `@value ||= compute`, however this doesn't work well if - `compute` might eventually give `nil` and we don't want to compute again. - Instead we could use `defined?` to check if the value is set or not. - However it's tedious to write such pattern, and `StrongMemoize` would - help us use such pattern. + We often do `@value ||= compute`. However, this doesn't work well if + `compute` might eventually give `nil` and you don't want to compute again. + Instead you could use `defined?` to check if the value is set or not. + It's tedious to write such pattern, and `StrongMemoize` would + help you use such pattern. Instead of writing patterns like this: @@ -118,7 +118,7 @@ Refer to <https://gitlab.com/gitlab-org/gitlab/blob/master/lib/gitlab/utils/stro end ``` - We could write it like: + You could write it like: ``` ruby class Find @@ -151,7 +151,7 @@ and the cache key would be based on the class name, method name, optionally customized instance level values, optionally customized method level values, and optional method arguments. -A simple example that only uses the instance level customised values: +A simple example that only uses the instance level customised values is: ``` ruby class UserAccess @@ -169,8 +169,8 @@ end This way, the result of `can_push_to_branch?` would be cached in `RequestStore.store` based on the cache key. If `RequestStore` is not -currently active, then it would be stored in a hash saved in an -instance variable, so the cache logic would be the same. +currently active, then it would be stored in a hash, and saved in an +instance variable so the cache logic would be the same. We can also set different strategies for different methods: diff --git a/doc/install/installation.md b/doc/install/installation.md index dd4b5544659..cc91f14045f 100644 --- a/doc/install/installation.md +++ b/doc/install/installation.md @@ -183,7 +183,7 @@ sudo make prefix=/usr/local install # When editing config/gitlab.yml (Step 5), change the git -> bin_path to /usr/local/bin/git ``` -For the [Custom Favicon](../customization/favicon.md) to work, GraphicsMagick +For the [Custom Favicon](../user/admin_area/appearance.md#favicon) to work, GraphicsMagick needs to be installed. ```sh diff --git a/doc/user/admin_area/settings/email.md b/doc/user/admin_area/settings/email.md index 6026f9dc735..4611d5f5c77 100644 --- a/doc/user/admin_area/settings/email.md +++ b/doc/user/admin_area/settings/email.md @@ -8,7 +8,7 @@ You can customize some of the content in emails sent from your GitLab instance. ## Custom logo -The logo in the header of some emails can be customized, see the [logo customization section](../../../customization/branded_page_and_email_header.md). +The logo in the header of some emails can be customized, see the [logo customization section](../appearance.md#navigation-bar). ## Custom additional text **(PREMIUM ONLY)** |