diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2020-03-05 12:07:48 +0000 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2020-03-05 12:07:48 +0000 |
commit | 5a6b36b60502c50ab59c0bc3c345793b70a3d548 (patch) | |
tree | 7cf2effbd48359b44970f8f345cfa12ce6843dfd /doc | |
parent | a76d34e6716aa8267111ecdcd21416e9dec3a08d (diff) | |
download | gitlab-ce-5a6b36b60502c50ab59c0bc3c345793b70a3d548.tar.gz |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc')
-rw-r--r-- | doc/administration/audit_events.md | 1 | ||||
-rw-r--r-- | doc/administration/high_availability/object_storage.md | 12 | ||||
-rw-r--r-- | doc/development/documentation/index.md | 63 | ||||
-rw-r--r-- | doc/user/project/releases/index.md | 12 |
4 files changed, 79 insertions, 9 deletions
diff --git a/doc/administration/audit_events.md b/doc/administration/audit_events.md index cc8135a86c4..2b068e64901 100644 --- a/doc/administration/audit_events.md +++ b/doc/administration/audit_events.md @@ -81,6 +81,7 @@ From there, you can see the following actions: - Release milestone associations changed - Permission to approve merge requests by committers was updated ([introduced](https://gitlab.com/gitlab-org/gitlab/issues/7531) in GitLab 12.9) - Permission to approve merge requests by authors was updated ([introduced](https://gitlab.com/gitlab-org/gitlab/issues/7531) in GitLab 12.9) +- Number of required approvals was updated ([introduced](https://gitlab.com/gitlab-org/gitlab/issues/7531) in GitLab 12.9) ### Instance events **(PREMIUM ONLY)** diff --git a/doc/administration/high_availability/object_storage.md b/doc/administration/high_availability/object_storage.md index 6ec34ea2f5d..dc451757a1c 100644 --- a/doc/administration/high_availability/object_storage.md +++ b/doc/administration/high_availability/object_storage.md @@ -4,22 +4,26 @@ type: reference # Cloud Object Storage -GitLab supports utilizing a Cloud Object Storage service over [NFS](nfs.md) for holding +GitLab supports utilizing a Cloud Object Storage service rather than [NFS](nfs.md) for holding numerous types of data. This is recommended in larger setups as object storage is -typically much more performant and reliable. +typically much more performant, reliable, and scalable. For configuring GitLab to use Object Storage refer to the following guides: 1. Make sure the [`git` user home directory](https://docs.gitlab.com/omnibus/settings/configuration.html#moving-the-home-directory-for-a-user) is on local disk. 1. Configure [database lookup of SSH keys](../operations/fast_ssh_key_lookup.md) to eliminate the need for a shared `authorized_keys` file. +1. Configure [object storage for backups](../../raketasks/backup_restore.md#uploading-backups-to-a-remote-cloud-storage). 1. Configure [object storage for job artifacts](../job_artifacts.md#using-object-storage) including [incremental logging](../job_logs.md#new-incremental-logging-architecture). 1. Configure [object storage for LFS objects](../lfs/lfs_administration.md#storing-lfs-objects-in-remote-object-storage). 1. Configure [object storage for uploads](../uploads.md#using-object-storage-core-only). 1. Configure [object storage for merge request diffs](../merge_request_diffs.md#using-object-storage). -1. Configure [object storage for packages](../packages/index.md#using-object-storage) (optional feature). -1. Configure [object storage for dependency proxy](../packages/dependency_proxy.md#using-object-storage) (optional feature). +1. Configure [object storage for container registry](../packages/container_registry.md#container-registry-storage-driver) (optional feature). +1. Configure [object storage for Mattermost](https://docs.mattermost.com/administration/config-settings.html#file-storage) (optional feature). +1. Configure [object storage for packages](../packages/index.md#using-object-storage) (optional feature). **(PREMIUM ONLY)** +1. Configure [object storage for dependency proxy](../packages/dependency_proxy.md#using-object-storage) (optional feature). **(ULTIMATE ONLY)** +1. Configure [object storage for Pseudonymizer](../pseudonymizer.md#configuration) (optional feature). **(ULTIMATE ONLY)** NOTE: **Note:** One current feature of GitLab that still requires a shared directory (NFS) is diff --git a/doc/development/documentation/index.md b/doc/development/documentation/index.md index 4fcdd8a1fb0..694acc16a97 100644 --- a/doc/development/documentation/index.md +++ b/doc/development/documentation/index.md @@ -393,15 +393,14 @@ merge request with new or changed docs is submitted, are: - [`docs lint`](https://gitlab.com/gitlab-org/gitlab/blob/master/.gitlab/ci/docs.gitlab-ci.yml#L48): Runs several tests on the content of the docs themselves: - [`lint-doc.sh` script](https://gitlab.com/gitlab-org/gitlab/blob/master/scripts/lint-doc.sh) - checks that: + runs the following checks and linters: - All cURL examples use the long flags (ex: `--header`, not `-H`). - The `CHANGELOG.md` does not contain duplicate versions. - No files in `doc/` are executable. - No new `README.md` was added. - - [markdownlint](#markdownlint). - - Nanoc tests, which you can [run locally](#previewing-the-changes-live) before - pushing to GitLab by executing the command `bundle exec nanoc check internal_links` - (or `internal_anchors`) on your local [`gitlab-docs`](https://gitlab.com/gitlab-org/gitlab-docs) directory: + - [markdownlint](#markdownlint). + - [Vale](#vale). + - Nanoc tests: - [`internal_links`](https://gitlab.com/gitlab-org/gitlab/blob/master/.gitlab/ci/docs.gitlab-ci.yml#L67) checks that all internal links (ex: `[link](../index.md)`) are valid. - [`internal_anchors`](https://gitlab.com/gitlab-org/gitlab/blob/master/.gitlab/ci/docs.gitlab-ci.yml#L69) @@ -410,6 +409,60 @@ merge request with new or changed docs is submitted, are: - If any code or the `doc/README.md` file is changed, a full pipeline will run, which runs tests for [`/help`](#gitlab-help-tests). +### Running tests & lint checks locally + +Apart from [previewing your changes locally](#previewing-the-changes-live), you can also run all lint checks +and Nanoc tests locally. + +#### Nanoc tests + +To execute Nanoc tests locally: + +1. Navigate to the [`gitlab-docs`](https://gitlab.com/gitlab-org/gitlab-docs) directory. +1. Run: + + ```shell + # Check for broken internal links + bundle exec nanoc check internal_links + + # Check for broken external links (might take a lot of time to complete). + # This test is set to be allowed to fail and is run only in the gitlab-docs project CI + bundle exec nanoc check internal_anchors + ``` + +#### Lint checks + +Lint checks are performed by the [`lint-doc.sh`](https://gitlab.com/gitlab-org/gitlab/blob/master/scripts/lint-doc.sh) +script and can be executed as follows: + +1. Navigate to the `gitlab` directory. +1. Run: + + ```shell + MD_DOC_PATH=path/to/my_doc.md scripts/lint-doc.sh + ``` + +Where `MD_DOC_PATH` points to the file or directory you would like to run lint checks for. +If you omit it completely, it will default to the `doc/` directory. +The output should be similar to: + +``` +=> Linting documents at path /path/to/gitlab as <user>... +=> Checking for cURL short options... +=> Checking for CHANGELOG.md duplicate entries... +=> Checking /path/to/gitlab/doc for executable permissions... +=> Checking for new README.md files... +=> Linting markdown style... +=> Linting prose... +✔ 0 errors, 0 warnings and 0 suggestions in 1 file. +✔ Linting passed +``` + +Note that this requires you to either have the required lint tools installed on your machine, +or a working Docker installation, in which case an image with these tools pre-installed will be used. + +For more information on available linters refer to the [linting](#linting) section. + ### Linting To help adhere to the [documentation style guidelines](styleguide.md), and improve the content diff --git a/doc/user/project/releases/index.md b/doc/user/project/releases/index.md index 8294bb4f6e2..f6e35ab03db 100644 --- a/doc/user/project/releases/index.md +++ b/doc/user/project/releases/index.md @@ -28,6 +28,18 @@ There are several ways to create a Release: Start by giving a [description](#release-description) to the Release and including its [assets](#release-assets), as follows. +## Release versioning + +Release versions are manually assigned by the user in the Release title. GitLab uses [Semantic Versioning](https://semver.org/) for our releases, and we recommend you do too. Use `(Major).(Minor).(Patch)`, as detailed in the [GitLab Policy for Versioning](../../../policy/maintenance.md#versioning). + +For example, for GitLab version `10.5.7`: + +- `10` represents the major version. The major release was `10.0.0`, but often referred to as `10.0`. +- `5` represents the minor version. The minor release was `10.5.0`, but often referred to as `10.5`. +- `7` represents the patch number. + +Any part of the version number can be multiple digits, for example, `13.10.11`. + ### Release description Every Release has a description. You can add any text you like, but we recommend |