diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2019-10-11 18:06:15 +0000 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2019-10-11 18:06:15 +0000 |
commit | 0dfbcd8f8b1587a7e10eb79940a8dc13bd72c664 (patch) | |
tree | 769b7b5eaea4354498ca0b91945e4733895bba43 /doc | |
parent | cd631619f465a0eee2fe714e720f6b6312dd3e56 (diff) | |
download | gitlab-ce-0dfbcd8f8b1587a7e10eb79940a8dc13bd72c664.tar.gz |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc')
-rw-r--r-- | doc/README.md | 1 | ||||
-rw-r--r-- | doc/administration/geo/replication/index.md | 1 | ||||
-rw-r--r-- | doc/administration/packages/index.md | 1 | ||||
-rw-r--r-- | doc/ci/introduction/index.md | 1 | ||||
-rw-r--r-- | doc/development/documentation/index.md | 39 | ||||
-rw-r--r-- | doc/development/feature_flags/controls.md | 42 | ||||
-rw-r--r-- | doc/user/packages/conan_repository/img/conan_package_view.png | bin | 0 -> 178189 bytes | |||
-rw-r--r-- | doc/user/packages/conan_repository/index.md | 135 | ||||
-rw-r--r-- | doc/user/packages/index.md | 1 | ||||
-rw-r--r-- | doc/user/permissions.md | 4 | ||||
-rw-r--r-- | doc/user/project/img/issue_boards_multi_select.png | bin | 21091 -> 0 bytes | |||
-rw-r--r-- | doc/user/project/index.md | 1 | ||||
-rw-r--r-- | doc/user/project/issue_board.md | 12 | ||||
-rw-r--r-- | doc/workflow/time_tracking.md | 2 |
14 files changed, 203 insertions, 37 deletions
diff --git a/doc/README.md b/doc/README.md index 0ba2fd27b6a..61265f94004 100644 --- a/doc/README.md +++ b/doc/README.md @@ -258,6 +258,7 @@ The following documentation relates to the DevOps **Package** stage: |:----------------------------------------------------------------|:-------------------------------------------------------| | [Container Registry](user/packages/container_registry/index.md) | The GitLab Container Registry enables every project in GitLab to have its own space to store [Docker](https://www.docker.com/) images. | | [Dependency Proxy](user/packages/dependency_proxy/index.md) **(PREMIUM)** | The GitLab Dependency Proxy sets up a local proxy for frequently used upstream images/packages. | +| [Conan Repository](user/packages/conan_repository/index.md) **(PREMIUM)** | The GitLab Conan Repository enables every project in GitLab to have its own space to store [Conan](https://conan.io/) packages. | | [Maven Repository](user/packages/maven_repository/index.md) **(PREMIUM)** | The GitLab Maven Repository enables every project in GitLab to have its own space to store [Maven](https://maven.apache.org/) packages. | | [NPM Registry](user/packages/npm_registry/index.md) **(PREMIUM)** | The GitLab NPM Registry enables every project in GitLab to have its own space to store [NPM](https://www.npmjs.com/) packages. | diff --git a/doc/administration/geo/replication/index.md b/doc/administration/geo/replication/index.md index 518291e8d8c..bcad820531c 100644 --- a/doc/administration/geo/replication/index.md +++ b/doc/administration/geo/replication/index.md @@ -281,6 +281,7 @@ You can keep track of the progress to include the missing items in: | [Container Registry](../../packages/container_registry.md) | Yes | No | | [NPM Registry](../../../user/packages/npm_registry/index.md) | No | No | | [Maven Packages](../../../user/packages/maven_repository/index.md) | No | No | +| [Conan Packages](../../../user/packages/conan_repository/index.md) | No | No | | [External merge request diffs](../../merge_request_diffs.md) | No, if they are on-disk | No | | Content in object storage ([track progress](https://gitlab.com/groups/gitlab-org/-/epics/1526)) | No | No | diff --git a/doc/administration/packages/index.md b/doc/administration/packages/index.md index 99ec5811681..d4afc65577e 100644 --- a/doc/administration/packages/index.md +++ b/doc/administration/packages/index.md @@ -8,6 +8,7 @@ The Packages feature allows GitLab to act as a repository for the following: | Software repository | Description | Available in GitLab version | | ------------------- | ----------- | --------------------------- | +| [Conan Repository](../../user/packages/conan_repository/index.md) | The GitLab Conan Repository enables every project in GitLab to have its own space to store [Conan](https://conan.io/) packages. | 12.4+ | | [Maven Repository](../../user/packages/maven_repository/index.md) | The GitLab Maven Repository enables every project in GitLab to have its own space to store [Maven](https://maven.apache.org/) packages. | 11.3+ | | [NPM Registry](../../user/packages/npm_registry/index.md) | The GitLab NPM Registry enables every project in GitLab to have its own space to store [NPM](https://www.npmjs.com/) packages. | 11.7+ | diff --git a/doc/ci/introduction/index.md b/doc/ci/introduction/index.md index 4389b2ce015..a644a89eee4 100644 --- a/doc/ci/introduction/index.md +++ b/doc/ci/introduction/index.md @@ -190,6 +190,7 @@ according to each stage (Verify, Package, Release). - Store Docker images with [Container Registry](../../user/packages/container_registry/index.md). - Store NPM packages with [NPM Registry](../../user/packages/npm_registry/index.md). **(PREMIUM)** - Store Maven artifacts with [Maven Repository](../../user/packages/maven_repository/index.md). **(PREMIUM)** + - Store Conan packages with [Conan Repository](../../user/packages/conan_repository/index.md). **(PREMIUM)** 1. **Release**: - Continuous Deployment, automatically deploying your app to production. - Continuous Delivery, manually click to deploy your app to production. diff --git a/doc/development/documentation/index.md b/doc/development/documentation/index.md index a5b47b3a5c0..4ac33fddfd2 100644 --- a/doc/development/documentation/index.md +++ b/doc/development/documentation/index.md @@ -374,17 +374,29 @@ The following GitLab features are used among others: ## Testing -We treat documentation as code, and so use tests to maintain the standards and quality of the docs. -The current tests are: - -1. `docs lint`: Check that all internal (relative) links work correctly and - that all cURL examples in API docs use the full switches. It's recommended - to [check locally](#previewing-the-changes-live) before pushing to GitLab by executing the command - `bundle exec nanoc check internal_links` on your local - [`gitlab-docs`](https://gitlab.com/gitlab-org/gitlab-docs) directory. In addition, - `docs-lint` also runs [`markdownlint`](#markdownlint) to ensure the - markdown is consistent across all documentation. -1. In a full pipeline, tests for [`/help`](#gitlab-help-tests). +We treat documentation as code, and so use tests in our CI pipeline to maintain the +standards and quality of the docs. The current tests, which run in CI jobs when a +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: + - 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: + - [`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) + checks that all internal anchors (ex: `[link](../index.md#internal_anchor)`) + are valid. +- If any code or the `doc/README.md` file is changed, a full pipeline will run, which + runs tests for [`/help`](#gitlab-help-tests). ### Linting @@ -490,7 +502,10 @@ four repos that are the sources for <https://docs.gitlab.com>: - <https://gitlab.com/charts/gitlab/blob/master/.markdownlint.json> By default all rules are enabled, so the configuration file is used to disable unwanted -rules, and also to configure optional parameters for enabled rules as needed. +rules, and also to configure optional parameters for enabled rules as needed. You can +also check [the issue](https://gitlab.com/gitlab-org/gitlab-foss/issues/64352) that +tracked the changes required to implement these rules, and details which rules were +on or off when `markdownlint` was enabled on the docs. ## Danger Bot diff --git a/doc/development/feature_flags/controls.md b/doc/development/feature_flags/controls.md index c8664831736..39f8f1bfea6 100644 --- a/doc/development/feature_flags/controls.md +++ b/doc/development/feature_flags/controls.md @@ -1,9 +1,11 @@ -# Access for enabling a feature flag in production +# Feature flag controls -In order to be able to turn on/off features behind feature flags in any of the +## Access + +To be able to turn on/off features behind feature flags in any of the GitLab Inc. provided environments such as staging and production, you need to -have access to the chatops bot. Chatops bot is currently running on the ops instance, -which is different from <https://gitlab.com> or <https://dev.gitlab.org>. +have access to the [Chatops](../chatops_on_gitlabcom.md) bot. The Chatops bot +is currently running on the ops instance, which is different from <https://gitlab.com> or <https://dev.gitlab.org>. Follow the Chatops document to [request access](../chatops_on_gitlabcom.md#requesting-access). @@ -14,6 +16,19 @@ run: /chatops run feature --help ``` +## Where to run commands + +To increase visibility, we recommend that GitLab team members run feature flag +related Chatops commands within certain slack channels based on the environment +and related feature. For the [staging](https://staging.gitlab.com) +and [development](https://dev.gitlab.org) environments of GitLab.com, +the commands should run in a channel for the stage the feature is relevant too. + +For example, use the `#s_monitor` channel for features developed by the +Monitor stage, Health group. + +For all production environment Chatops commands, use the `#production` channel. + ## Rolling out changes When the changes are deployed to the environments it is time to start @@ -28,7 +43,7 @@ easier to measure the impact of both separately. GitLab's feature library (using [Flipper](https://github.com/jnunemaker/flipper), and covered in the [Feature Flags process](process.md) guide) supports rolling out changes to a percentage of -users. This in turn can be controlled using [GitLab chatops](../../ci/chatops/README.md). +users. This in turn can be controlled using [GitLab Chatops](../../ci/chatops/README.md). For an up to date list of feature flag commands please see [the source code](https://gitlab.com/gitlab-com/chatops/blob/master/lib/chatops/commands/feature.rb). @@ -37,7 +52,7 @@ Note that all the examples in that file must be preceded by If you get an error "Whoops! This action is not allowed. This incident will be reported." that means your Slack account is not allowed to -change feature flags or you do not [have access](#access-for-enabling-a-feature-flag-in-production). +change feature flags or you do not [have access](#access). ### Enabling feature for internal testing @@ -64,7 +79,7 @@ there for any exceptions while testing your feature after enabling the feature f Once you are confident enough that these environments are in a good state with your feature enabled, you can roll out the change to GitLab.com. -## Enabling feature for GitLab.com +### Enabling a feature for GitLab.com Similar to above, to enable a feature for 25% of all users, run the following in Slack: @@ -114,10 +129,17 @@ merge request has to be picked into a stable branch, make sure to also add the appropriate "Pick into X" label (e.g. "Pick into XX.X"). See [the process document](process.md#including-a-feature-behind-feature-flag-in-the-final-release) for further details. -When a feature gate has been removed from the code base, the value still exists -in the database. -This can be removed through ChatOps: +When a feature gate has been removed from the code base, the feature +record still exists in the database that the flag was deployed too. +The record can be deleted once the MR is deployed to each environment: +```sh +/chatops run feature delete some_feature --dev +/chatops run feature delete some_feature --staging ``` + +Then, you can delete it from production after the MR is deployed to prod: + +```sh /chatops run feature delete some_feature ``` diff --git a/doc/user/packages/conan_repository/img/conan_package_view.png b/doc/user/packages/conan_repository/img/conan_package_view.png Binary files differnew file mode 100644 index 00000000000..79a188d7856 --- /dev/null +++ b/doc/user/packages/conan_repository/img/conan_package_view.png diff --git a/doc/user/packages/conan_repository/index.md b/doc/user/packages/conan_repository/index.md new file mode 100644 index 00000000000..f81756f7979 --- /dev/null +++ b/doc/user/packages/conan_repository/index.md @@ -0,0 +1,135 @@ +# GitLab Conan Repository **(PREMIUM)** + +> [Introduced](https://gitlab.com/gitlab-org/gitlab-ee/issues/8248) in [GitLab Premium](https://about.gitlab.com/pricing/) 12.4. + +With the GitLab Conan Repository, every +project can have its own space to store Conan packages. + +![GitLab Conan Repository](img/conan_package_view.png) + +## Enabling the Conan Repository + +NOTE: **Note:** +This option is available only if your GitLab administrator has +[enabled support for the Conan Repository](../../../administration/packages/index.md).**(PREMIUM ONLY)** + +After the Conan Repository is enabled, it will be available for all new projects +by default. To enable it for existing projects, or if you want to disable it: + +1. Navigate to your project's **Settings > General > Permissions**. +1. Find the Packages feature and enable or disable it. +1. Click on **Save changes** for the changes to take effect. + +You should then be able to see the **Packages** section on the left sidebar. + +Before proceeding to authenticating with the GitLab Conan Repository, you should +get familiar with the package naming convention. + +## Authenticating to the GitLab Conan Repository + +You will need to generate a [personal access token](../../../user/profile/personal_access_tokens.md) for repository authentication. + +Now you can run conan commands using your token. + +`CONAN_LOGIN_USERNAME=<gitlab-username> CONAN_PASSWORD=<personal_access_token> conan upload Hello/0.2@user/channel --remote=gitlab` +`CONAN_LOGIN_USERNAME=<gitlab-username> CONAN_PASSWORD=<personal_access_token> conan search Hello* --all --remote=gitlab` + +Alternatively, you can set the `CONAN_LOGIN_USERNAME` and `CONAN_PASSWORD` in your local conan config to be used when connecting to the `gitlab` remote. The examples here show the username and password inline. + +Next, you'll need to set your Conan remote to point to the GitLab Package Registry. + +## Setting the Conan remote to the GitLab Package Registry + +After you authenticate to the [GitLab Conan Repository](#authenticating-to-the-gitlab-conan-repository), +you can set the Conan remote: + +```sh +conan remote add gitlab https://gitlab.example.com/api/v4/packages/conan +``` + +Once the remote is set, you can use the remote when running Conan commands: + +```sh +conan search Hello* --all --remote=gitlab +``` + +## Supported CLI commands + +The GitLab Conan repository supports the following Conan CLI commands: + +- `conan upload`: Upload your recipe and package files to the GitLab Package Registry. +- `conan install`: Install a conan package from the GitLab Package Registry, this includes using the `conan.txt` file. +- `conan search`: Search the GitLab Package Registry for public packages, and private packages you have permission to view. +- `conan info`: View the info on a given package from the GitLab Package Registry. +- `conan remove`: Delete the package from the GitLab Package Registry. + +## Uploading a package + +First you need to [create your Conan package locally](https://docs.conan.io/en/latest/creating_packages/getting_started.html). In order to work with the GitLab Package Registry, a specific [naming convention](#package-recipe-naming-convention) must be followed. + +Ensure you have a project created on GitLab and that the personal access token you are using has the correct permissions for write access to the container registry by selecting the `api` [scope](../../../user/profile/personal_access_tokens.md#limiting-scopes-of-a-personal-access-token). + +You can upload your package to the GitLab Package Registry using the `conan upload` command: + +```sh +CONAN_LOGIN_USERNAME=<gitlab-username> CONAN_PASSWORD=<personal_access_token> conan upload Hello/0.1@my-group+my-project/beta --all --remote=gitlab +``` + +### Package recipe naming convention + +Standard Conan recipe convention looks like `package_name/version@username/channel`. + +**Recipe usernames must be the `+` separated project path**. The package +name may be anything, but it is preferred that the project name be used unless +it is not possible due to a naming collision. For example: + +| Project | Package | Supported | +| ---------------------------------- | ----------------------------------------------- | --------- | +| `foo/bar` | `my-package/1.0.0@foo+bar/stable` | Yes | +| `foo/bar-baz/buz` | `my-package/1.0.0@foo+bar-baz+buz/stable` | Yes | +| `gitlab-org/gitlab-ce` | `my-package/1.0.0@gitlab-org+gitlab-ce/stable` | Yes | +| `gitlab-org/gitlab-ce` | `my-package/1.0.0@foo/stable` | No | + +NOTE: **Note:** +A future iteration will extend support to [project and group level](https://gitlab.com/gitlab-org/gitlab/issues/11679) remotes which will allow for more flexible naming conventions. + +## Installing a package + +Add the conan package to the `[requires]` section of your `conan.txt` file and they will be installed when you run `conan install` within your project. + +## Removing a package + +There are two ways to remove a Conan package from the GitLab Package Registry. + +- **Using the Conan client in the command line:** + + ```sh + CONAN_LOGIN_USERNAME=<gitlab-username> CONAN_PASSWORD=<personal_access_token> conan remove Hello/0.2@user/channel -r gitlab + ``` + + NOTE: **Note:** + This command will remove all recipe and binary package files from the Package Registry. + +- **GitLab project interface**: in the packages view of your project page, you can delete packages by clicking the red trash icons. + +## Searching the GitLab Package Registry for Conan packages + +The `conan search` command can be run searching by full or partial package name, or by exact recipe. + +To search using a partial name, use the wildcard symbol `*`, which should be placed at the end of your search (e.g., `my-packa*`): + +```sh +CONAN_LOGIN_USERNAME=<gitlab-username> CONAN_PASSWORD=<personal_access_token> conan search Hello --all --remote=gitlab +CONAN_LOGIN_USERNAME=<gitlab-username> CONAN_PASSWORD=<personal_access_token> conan search He* --all --remote=gitlab +CONAN_LOGIN_USERNAME=<gitlab-username> CONAN_PASSWORD=<personal_access_token> conan search Hello/1.0.0@my-group+my-project/stable --all --remote=gitlab +``` + +The scope of your search will include all projects you have permission to access, this includes your private projects as well as all public projects. + +## Fetching Conan package info from the GitLab Package Registry + +The `conan info` command will return info about a given package: + +```sh +CONAN_LOGIN_USERNAME=<gitlab-username> CONAN_PASSWORD=<personal_access_token> conan info Hello/1.0.0@my-group+my-project/stable -r gitlab +``` diff --git a/doc/user/packages/index.md b/doc/user/packages/index.md index 506eb5703a6..9873bd80e8b 100644 --- a/doc/user/packages/index.md +++ b/doc/user/packages/index.md @@ -10,6 +10,7 @@ The Packages feature allows GitLab to act as a repository for the following: | ------------------- | ----------- | --------------------------- | | [Container Registry](container_registry/index.md) | The GitLab Container Registry enables every project in GitLab to have its own space to store [Docker](https://www.docker.com/) images. | 8.8+ | | [Dependency Proxy](dependency_proxy/index.md) **(PREMIUM)** | The GitLab Dependency Proxy sets up a local proxy for frequently used upstream images/packages. | 11.11+ | +| [Conan Repository](conan_repository/index.md) **(PREMIUM)** | The GitLab Conan Repository enables every project in GitLab to have its own space to store [Conan](https://conan.io/) packages. | 12.4+ | | [Maven Repository](maven_repository/index.md) **(PREMIUM)** | The GitLab Maven Repository enables every project in GitLab to have its own space to store [Maven](https://maven.apache.org/) packages. | 11.3+ | | [NPM Registry](npm_registry/index.md) **(PREMIUM)** | The GitLab NPM Registry enables every project in GitLab to have its own space to store [NPM](https://www.npmjs.com/) packages. | 11.7+ | diff --git a/doc/user/permissions.md b/doc/user/permissions.md index 85930365708..90874eca2eb 100644 --- a/doc/user/permissions.md +++ b/doc/user/permissions.md @@ -76,8 +76,8 @@ The following table depicts the various user permission levels in a project. | See a list of merge requests | | ✓ | ✓ | ✓ | ✓ | | View project statistics | | ✓ | ✓ | ✓ | ✓ | | View Error Tracking list | | ✓ | ✓ | ✓ | ✓ | -| Pull from [Maven repository](packages/maven_repository/index.md) or [NPM registry](packages/npm_registry/index.md) **(PREMIUM)** | | ✓ | ✓ | ✓ | ✓ | -| Publish to [Maven repository](packages/maven_repository/index.md) or [NPM registry](packages/npm_registry/index.md) **(PREMIUM)** | | | ✓ | ✓ | ✓ | +| Pull from [Conan repository](packages/conan_repository/index.md), [Maven repository](packages/maven_repository/index.md), or [NPM registry](packages/npm_registry/index.md) **(PREMIUM)** | | ✓ | ✓ | ✓ | ✓ | +| Publish to [Conan repository](packages/conan_repository/index.md), [Maven repository](packages/maven_repository/index.md), or [NPM registry](packages/npm_registry/index.md) **(PREMIUM)** | | | ✓ | ✓ | ✓ | | Upload [Design Management](project/issues/design_management.md) files **(PREMIUM)** | | | ✓ | ✓ | ✓ | | Create new branches | | | ✓ | ✓ | ✓ | | Push to non-protected branches | | | ✓ | ✓ | ✓ | diff --git a/doc/user/project/img/issue_boards_multi_select.png b/doc/user/project/img/issue_boards_multi_select.png Binary files differdeleted file mode 100644 index 34ec0c1c58e..00000000000 --- a/doc/user/project/img/issue_boards_multi_select.png +++ /dev/null diff --git a/doc/user/project/index.md b/doc/user/project/index.md index fff587027cf..ef80c8fc6a3 100644 --- a/doc/user/project/index.md +++ b/doc/user/project/index.md @@ -95,6 +95,7 @@ When you create a project in GitLab, you'll have access to a large number of - [Releases](releases/index.md): a way to track deliverables in your project as snapshot in time of the source, build output, and other metadata or artifacts associated with a released version of your code. +- [Conan packages](../packages/conan_repository/index.md): your private Conan repository in GitLab. **(PREMIUM)** - [Maven packages](../packages/maven_repository/index.md): your private Maven repository in GitLab. **(PREMIUM)** - [NPM packages](../packages/npm_registry/index.md): your private NPM package registry in GitLab. **(PREMIUM)** - [Code owners](code_owners.md): specify code owners for certain files **(STARTER)** diff --git a/doc/user/project/issue_board.md b/doc/user/project/issue_board.md index e9a7a15b630..0c0068ddd09 100644 --- a/doc/user/project/issue_board.md +++ b/doc/user/project/issue_board.md @@ -180,18 +180,6 @@ These are shortcuts to your last 4 visited boards. When you're revisiting an issue board in a project or group with multiple boards, GitLab will automatically load the last board you visited. -### Multi-select Issue Cards - -As the name suggest, multi-select issue cards allows more than one issue card -to be dragged and dropped across different lists. This becomes helpful while -moving and grooming a lot of issues at once. - -You can multi-select an issue card by pressing `CTRL` + `Left mouse click` on -Windows or `CMD` + `Left mouse click` on MacOS. Once done, start by dragging one -of the issue card you have selected and drop it in the new list you want. - -![Multi-select Issue Cards](img/issue_boards_multi_select.png) - ### Configurable Issue Boards **(STARTER)** > Introduced in [GitLab Starter Edition 10.2](https://about.gitlab.com/2017/11/22/gitlab-10-2-released/#issue-boards-configuration). diff --git a/doc/workflow/time_tracking.md b/doc/workflow/time_tracking.md index 8c57c43b7d6..3d2e1de24da 100644 --- a/doc/workflow/time_tracking.md +++ b/doc/workflow/time_tracking.md @@ -11,7 +11,7 @@ requests within GitLab. ## Overview -Time Tracking allows you: +Time Tracking allows you to: - Record the time spent working on an issue or a merge request. - Add an estimate of the amount of time needed to complete an issue or a merge |