From 78d044004cbca43e64bd07973c42b35c98897a84 Mon Sep 17 00:00:00 2001 From: Kate Grechishkina <khrechyshkina@gitlab.com> Date: Mon, 31 Jul 2023 16:57:33 +0000 Subject: [PATCH] Document naming requirement for packages installed at the group-level --- doc/user/packages/npm_registry/index.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/doc/user/packages/npm_registry/index.md b/doc/user/packages/npm_registry/index.md index 0fe2b39a5911c..3a7f5da2629c2 100644 --- a/doc/user/packages/npm_registry/index.md +++ b/doc/user/packages/npm_registry/index.md @@ -29,12 +29,13 @@ Do not use authentication methods other than the methods documented here. Undocu Depending on how the package is installed, you may need to adhere to the naming convention. -You can use one of two API endpoints to install packages: +You can use one of three API endpoints to install packages: - **Instance-level**: Use when you have many npm packages in different GitLab groups or in their own namespace. +- **Group-level**: Use when you have many npm packages in different projects under the same group or subgroup. - **Project-level**: Use when you have few npm packages and they are not in the same GitLab group. -If you plan to install a package through the [project level](#install-from-the-project-level), then you do not have to adhere to the naming convention. +If you plan to install a package through the [project level](#install-from-the-project-level) or [group level](#install-from-the-group-level), then you do not have to adhere to the naming convention. If you plan to install a package through the [instance level](#install-from-the-instance-level), then you must name your package with a [scope](https://docs.npmjs.com/misc/scope/). Scoped packages begin with a `@` have the format of `@owner/package-name`. You can set up the scope for your package in the `.npmrc` file and by using the `publishConfig` option in the `package.json`. -- GitLab