Skip to content
Snippets Groups Projects
Commit 84c7d979 authored by DJ Mountney's avatar DJ Mountney :red_circle:
Browse files

Merge branch 'docs/add-no-bare-url-mdl-rule' into 'master'

Disallow bare URLs from project

See merge request !3372
parents 477de305 93a6b6b0
No related branches found
No related tags found
1 merge request!3372Disallow bare URLs from project
......@@ -38,7 +38,7 @@ Sometimes, softwares' source code may have to be patched in order to use it with
`**Note:` Patches may be found inside the [config/patches](https://gitlab.com/gitlab-org/omnibus-gitlab/tree/master/config/patches) folder in the repository.
For more extensive changes it may be more convenient to track the changes required in a branch on the mirror. The pattern to follow for this is to create a branch from an upstream tag or sha making reference to that branchpoint in the name of the branch. As an example from the omnibus codebase, `gitlab-omnibus-v5.6.10` is based on the `v5.6.10` tag of the upstream project. This allows for us to generate a comparison link like https://gitlab.com/gitlab-org/omnibus/compare/v5.6.10...gitlab-omnibus-v5.6.10 to identify what local changes are present.
For more extensive changes it may be more convenient to track the changes required in a branch on the mirror. The pattern to follow for this is to create a branch from an upstream tag or sha making reference to that branchpoint in the name of the branch. As an example from the omnibus codebase, `gitlab-omnibus-v5.6.10` is based on the `v5.6.10` tag of the upstream project. This allows for us to generate a comparison link like `https://gitlab.com/gitlab-org/omnibus/compare/v5.6.10...gitlab-omnibus-v5.6.10` to identify what local changes are present.
## Global GitLab configuration template
......
# Adding new gitlab-ctl commands
New gitlab-ctl commands can be added to two directory : `files/gitlab-ctl-commands` and` files/gitlab-ctl-commands-ee`. Chef stores gitlab-ctl commands in `/opt/gitlab/embedded/service/omnibus-ctl`
New gitlab-ctl commands can be added to two directory : `files/gitlab-ctl-commands` and` files/gitlab-ctl-commands-ee`. Chef stores gitlab-ctl commands in `/opt/gitlab/embedded/service/omnibus-ctl`
There are two main functions you will use to add commands (https://github.com/chef/omnibus-ctl):
There are two main functions you will use to add commands (<https://github.com/chef/omnibus-ctl>):
### add_command_under_category(string, string, string, int, ruby_block)
......@@ -11,9 +11,9 @@ This method will add a new command to your ctl under a category, useful for grou
Input arguments:
1. Name of the command.
2. Category of the command. It should be string consisting of only characters and "-". If the category does not exist, it will be added. Default categories are "general" and "service-management" (if the latter is enabled).
3. Description. This will be outputted below the command name when the help command is run.
4. Ruby block. Ruby code to be executed when your command is run (arguments to that command will be passed into the block).
1. Category of the command. It should be string consisting of only characters and "-". If the category does not exist, it will be added. Default categories are "general" and "service-management" (if the latter is enabled).
1. Description. This will be outputted below the command name when the help command is run.
1. Ruby block. Ruby code to be executed when your command is run (arguments to that command will be passed into the block).
### add_command(string, string, int, ruby_block)
......
......@@ -3,7 +3,7 @@
In order to add a new component to GitLab, you should follow these steps:
1. [Fetch and compile the software during build](#fetch-and-compile-the-software-during-build)
2. [Add a dependency for the software definition to another component](#add-a-dependency-for-the-software-definition-to-another-component)
1. [Add a dependency for the software definition to another component](#add-a-dependency-for-the-software-definition-to-another-component)
## Fetch and compile the software during build
......@@ -16,7 +16,7 @@ When adding a component that should be fetched from git the clone address of the
repositories of the local mirror and upstream should be added to
`/.custom_sources.yml`.
The local mirror should be created in the https://dev.gitlab.org/omnibus-mirror
The local mirror should be created in the <https://dev.gitlab.org/omnibus-mirror>
project by a member of the Distribution team. It should have the
`omnibus-builder deploy key` enabled.
......
......@@ -18,8 +18,8 @@ computer in order to test GitLab.
The first thing you need to interact with OpenShift Origin, are the `oc` client tools for your terminal:
1. Download and install the OpenShift Origin Client Tools onto your path if you don't already have them.
- Found here: https://github.com/openshift/origin/releases
- Example: https://github.com/openshift/origin/releases/download/v1.4.1/openshift-origin-client-tools-v1.4.1-3f9807a-linux-64bit.tar.gz
- Found here: <https://github.com/openshift/origin/releases>
- Example: <https://github.com/openshift/origin/releases/download/v1.4.1/openshift-origin-client-tools-v1.4.1-3f9807a-linux-64bit.tar.gz>
Next you need to setup an OpenShift Origin environment. To setup the environment you can use the production installer
on a cloud machine, use minishift on your local machine (uses kvm or xhyve), or setup an instance
......@@ -27,7 +27,7 @@ using docker for the master, and your own machine as the slave using `oc cluster
### Minishift
Installation instructions for Minishift can be found at https://docs.openshift.org/latest/minishift/getting-started/installing.html
Installation instructions for Minishift can be found at <https://docs.openshift.org/latest/minishift/getting-started/installing.html>
1. Before installing Minishift you need to install the proper docker machine driver.
- For Linux, install the [kvm driver](https://minishift.io/docs/docker-machine-drivers.html#kvm-driver)
......@@ -45,7 +45,7 @@ Installation instructions for Minishift can be found at https://docs.openshift.o
### Docker oc cluster up
If you have Docker installed, you can setup OpenShift Origin on your local machine: https://github.com/openshift/origin/blob/master/docs/cluster_up_down.md
If you have Docker installed, you can setup OpenShift Origin on your local machine: <https://github.com/openshift/origin/blob/master/docs/cluster_up_down.md>
`**Note:`this currently does not start if you are using docker-ce/ee with the new version scheme (17.xx)
......
......@@ -280,7 +280,7 @@ If this is not the case, there are two options:
Consider these notes when upgrading GitLab Mattermost:
1. Starting in Mattermost v4.2, user-supplied URLs such as those used for Open Graph metadata, webhooks, or slash commands will no longer be allowed to connect to reserved IP addresses including loopback or link-local addresses used for internal networks by default. This change may cause private integrations to break in testing environments, which may point to a URL such as http://127.0.0.1:1021/my-command.
1. Starting in Mattermost v4.2, user-supplied URLs such as those used for Open Graph metadata, webhooks, or slash commands will no longer be allowed to connect to reserved IP addresses including loopback or link-local addresses used for internal networks by default. This change may cause private integrations to break in testing environments, which may point to a URL such as `http://127.0.0.1:1021/my-command`.
- If you point private integrations to such URLs, you may whitelist such domains, IP addresses, or CIDR notations via the [AllowedUntrustedInternalConnections config setting](https://github.com/mattermost/docs/blob/05cd1685deff85b2a2c5130d889f935b808ae159/source/administration/config-settings.rst#allow-untrusted-internal-connections-to) in your local environment. Although not recommended, you may also whitelist the addresses in your production environments.
- Push notification, OAuth 2.0 and WebRTC server URLs are trusted and not affected by this setting.
1. Starting in Mattermost v4.2, Mattermost now handles multiple content-types for integrations. Make sure your integrations have been set to use the appropriate content-type.
......
......@@ -9,7 +9,7 @@ New GitLab templates for OpenShift are prepared as part of our our [cloud image
## Update the template to latest GitLab release
Within the template we reference our Docker image. Go to https://store.docker.com/community/images/gitlab/gitlab-ce/tags
Within the template we reference our Docker image. Go to <https://store.docker.com/community/images/gitlab/gitlab-ce/tags>
and find the newest descriptive tag. e.g. `8.13.3-ce.0`
Then update the image stream in the template with the name and tag:
......@@ -64,9 +64,9 @@ For setting up a OpenShift Origin development environment for testing see
Set up a new GitLab install using the updated template. Smoke test the install:
1. Login works
2. Create project succeeds
3. Readme can be created through the UI
4. Repo can be clone and pushed to over http
1. Create project succeeds
1. Readme can be created through the UI
1. Repo can be clone and pushed to over http
## Submit new Merge Request
......
......@@ -127,7 +127,7 @@ GitLab includes support for running with separate redis instances for different
## Redis Sentinel
For details on configuring Redis Sentinel, see
https://docs.gitlab.com/ce/administration/high_availability/redis.html.
<https://docs.gitlab.com/ce/administration/high_availability/redis.html>.
## Setting the Redis Cache instance as an LRU
......
......@@ -40,7 +40,7 @@ package to your GitLab server.
## Updating from GitLab `6.6.0.pre1` to `6.6.4`
1. First, download the latest package from https://about.gitlab.com/downloads/
1. First, download the latest package from <https://about.gitlab.com/downloads/>
to your GitLab server.
......
......@@ -129,7 +129,7 @@ docs-lint:
# Lint Markdown
# https://github.com/markdownlint/markdownlint/blob/master/docs/RULES.md
- bundle exec mdl content/omnibus/**/*.md --rules \
MD032
MD032,MD034
# Build HTML from Markdown
- bundle exec nanoc
# Check the internal links
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment