From f6b349ed51e973c4a01d2f1a85459816f478186c Mon Sep 17 00:00:00 2001 From: GitLab Bot Date: Fri, 23 Apr 2021 21:09:46 +0000 Subject: Add latest changes from gitlab-org/gitlab@master --- doc/api/graphql/reference/index.md | 56 +++++++++++++++++++++++ doc/development/documentation/styleguide/index.md | 21 ++++++--- doc/user/packages/npm_registry/index.md | 42 ++++++++++++++++- 3 files changed, 112 insertions(+), 7 deletions(-) (limited to 'doc') diff --git a/doc/api/graphql/reference/index.md b/doc/api/graphql/reference/index.md index 765478c73cd..fcf9e4b91cf 100644 --- a/doc/api/graphql/reference/index.md +++ b/doc/api/graphql/reference/index.md @@ -5239,6 +5239,29 @@ The edge type for [`Label`](#label). | `cursor` | [`String!`](#string) | A cursor for use in pagination. | | `node` | [`Label`](#label) | The item at the end of the edge. | +#### `LfsObjectRegistryConnection` + +The connection type for [`LfsObjectRegistry`](#lfsobjectregistry). + +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| `edges` | [`[LfsObjectRegistryEdge]`](#lfsobjectregistryedge) | A list of edges. | +| `nodes` | [`[LfsObjectRegistry]`](#lfsobjectregistry) | A list of nodes. | +| `pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | + +#### `LfsObjectRegistryEdge` + +The edge type for [`LfsObjectRegistry`](#lfsobjectregistry). + +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| `cursor` | [`String!`](#string) | A cursor for use in pagination. | +| `node` | [`LfsObjectRegistry`](#lfsobjectregistry) | The item at the end of the edge. | + #### `LicenseHistoryEntryConnection` The connection type for [`LicenseHistoryEntry`](#licensehistoryentry). @@ -8317,6 +8340,22 @@ four standard [pagination arguments](#connection-pagination-arguments): | ---- | ---- | ----------- | | `ids` | [`[ID!]`](#id) | Filters registries by their ID. | +##### `GeoNode.lfsObjectRegistries` + +Find LFS object registries on this Geo node. Available only when feature flag `geo_lfs_object_replication` is enabled. + +Returns [`LfsObjectRegistryConnection`](#lfsobjectregistryconnection). + +This field returns a [connection](#connections). It accepts the +four standard [pagination arguments](#connection-pagination-arguments): +`before: String`, `after: String`, `first: Int`, `last: Int`. + +###### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| `ids` | [`[ID!]`](#id) | Filters registries by their ID. | + ##### `GeoNode.mergeRequestDiffRegistries` Find merge request diff registries on this Geo node. @@ -9327,6 +9366,23 @@ four standard [pagination arguments](#connection-pagination-arguments): | `title` | [`String!`](#string) | Content of the label. | | `updatedAt` | [`Time!`](#time) | When this label was last updated. | +### `LfsObjectRegistry` + +Represents the Geo sync and verification state of an LFS object. + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| `createdAt` | [`Time`](#time) | Timestamp when the LfsObjectRegistry was created. | +| `id` | [`ID!`](#id) | ID of the LfsObjectRegistry. | +| `lastSyncFailure` | [`String`](#string) | Error message during sync of the LfsObjectRegistry. | +| `lastSyncedAt` | [`Time`](#time) | Timestamp of the most recent successful sync of the LfsObjectRegistry. | +| `lfsObjectId` | [`ID!`](#id) | ID of the LFS object. | +| `retryAt` | [`Time`](#time) | Timestamp after which the LfsObjectRegistry should be resynced. | +| `retryCount` | [`Int`](#int) | Number of consecutive failed sync attempts of the LfsObjectRegistry. | +| `state` | [`RegistryState`](#registrystate) | Sync state of the LfsObjectRegistry. | + ### `LicenseHistoryEntry` Represents an entry from the Cloud License history. diff --git a/doc/development/documentation/styleguide/index.md b/doc/development/documentation/styleguide/index.md index 25cdbaf75ba..912a046c2c0 100644 --- a/doc/development/documentation/styleguide/index.md +++ b/doc/development/documentation/styleguide/index.md @@ -1112,13 +1112,9 @@ document to ensure it links to the most recent version of the file. When documenting navigation through the user interface: - Use the exact wording as shown in the UI, including any capital letters as-is. -- Use bold text for navigation items and the char "greater than" (`>`) as a - separator. For example: `From your project, go to **Settings > CI/CD**`. -- If there are any expandable menus, make sure to mention that the user needs to - expand the tab to find the settings you're referring to. For example: - `From your group, go to **Settings > CI/CD** and expand **General pipelines**`. +- Use bold text for navigation items. -### Navigational elements +### What to call the menus Use these terms when referring to the main GitLab user interface elements: @@ -1130,6 +1126,19 @@ elements: - **Right sidebar**: This is the navigation sidebar on the right of the user interface, specific to the open issue, merge request, or epic. +### How to document the left sidebar + +To be consistent, use this format when you refer to the left sidebar. + +- Go to your project and select **Settings > CI/CD**. +- Go to your group and select **Settings > CI/CD**. +- Go to the Admin Area (**{admin}**) and select **Overview > Projects**. + +For expandable menus, use this format: + +1. Go to your group and select **Settings > CI/CD**. +1. Expand **General pipelines**. + ## Images Images, including screenshots, can help a reader better understand a concept. diff --git a/doc/user/packages/npm_registry/index.md b/doc/user/packages/npm_registry/index.md index b6312002184..8e3718f3255 100644 --- a/doc/user/packages/npm_registry/index.md +++ b/doc/user/packages/npm_registry/index.md @@ -43,7 +43,7 @@ The npm version is shown in the output: ### Install Yarn As an alternative to npm, you can install Yarn in your local environment by following the -instructions at [yarnpkg.com](https://classic.yarnpkg.com/en/docs/install). +instructions at [classic.yarnpkg.com](https://classic.yarnpkg.com/en/docs/install). When installation is complete, verify you can use Yarn in your terminal by running: @@ -305,6 +305,46 @@ See the [Publish npm packages to the GitLab Package Registry using semantic-release](../../../ci/examples/semantic-release.md) step-by-step guide and demo project for a complete example. +## Configure the GitLab npm registry with Yarn 2 + +You can get started with Yarn 2 by following the documentation at +[https://yarnpkg.com/getting-started/install](https://yarnpkg.com/getting-started/install). + +To publish and install with the project-level npm endpoint, set the following configuration in +`.yarnrc.yml`: + +```yaml +npmScopes: + foo: + npmRegistryServer: "https://gitlab.example.com/api/v4/projects//packages/npm/" + npmPublishRegistry: "https://gitlab.example.com/api/v4/projects//packages/npm/" + +npmRegistries: + //gitlab.example.com/api/v4/projects//packages/npm/: + npmAlwaysAuth: true + npmAuthToken: "" +``` + +For the instance-level npm endpoint, use this Yarn 2 configuration in `.yarnrc.yml`: + +```yaml +npmScopes: + foo: + npmRegistryServer: "https://gitlab.example.com/api/v4/packages/npm/" + +npmRegistries: + //gitlab.example.com/api/v4/packages/npm/: + npmAlwaysAuth: true + npmAuthToken: "" +``` + +In this configuration: + +- Replace `` with your personal access token or deploy token. +- Replace `` with your project's ID, which you can find on the project's home page. +- Replace `gitlab.example.com` with your domain name. +- Your scope is `foo`, without `@`. + ## Publishing packages with the same name or version You cannot publish a package if a package of the same name and version already exists. -- cgit v1.2.3