Skip to content
Snippets Groups Projects
Verified Commit 8e49403a authored by Lorena Ciutacu's avatar Lorena Ciutacu :palm_tree: Committed by GitLab
Browse files

Apply 5 suggestion(s) to 2 file(s)


Co-authored-by: Christina Lohr's avatarChristina Lohr <clohr@gitlab.com>
parent f1ffab96
No related branches found
No related tags found
2 merge requests!162233Draft: Script to update Topology Service Gem,!155733Document project overview page
...@@ -248,8 +248,8 @@ For example: ...@@ -248,8 +248,8 @@ For example:
Files returned by this endpoint always have the `plain/text` content type. Files returned by this endpoint always have the `plain/text` content type.
In both examples, replace `<project-id>` with a valid project ID. You can find the project ID on the, In both examples, replace `<project-id>` with a valid project ID. You can find the project ID on the
[project overview page](../../user/project/working_with_projects.md#access-the-project-overview-page-by-using-the-project-id). [project overview page](../../user/project/working_with_projects.md#access-a-project-by-using-the-project-id).
Artifacts for [parent and child pipelines](../pipelines/downstream_pipelines.md#parent-child-pipelines) Artifacts for [parent and child pipelines](../pipelines/downstream_pipelines.md#parent-child-pipelines)
are searched in hierarchical order from parent to child. For example, if both parent and are searched in hierarchical order from parent to child. For example, if both parent and
......
...@@ -71,7 +71,7 @@ After setting up WIF, you must grant the WIF principal access to the secrets in ...@@ -71,7 +71,7 @@ After setting up WIF, you must grant the WIF principal access to the secrets in
[Project's dashboard](https://console.cloud.google.com/home/dashboard). [Project's dashboard](https://console.cloud.google.com/home/dashboard).
- `POOL_ID`: The ID (not name) of the Workload Identity Pool created in the first section, - `POOL_ID`: The ID (not name) of the Workload Identity Pool created in the first section,
for example `gitlab-pool`. for example `gitlab-pool`.
- `GITLAB_PROJECT_ID`: The GitLab project ID found on the [project overview page](../../user/project/working_with_projects.md#access-the-project-overview-page-by-using-the-project-id). - `GITLAB_PROJECT_ID`: The GitLab project ID found on the [project overview page](../../user/project/working_with_projects.md#access-a-project-by-using-the-project-id).
1. Assign the role **Secret Manager Secret Accessor**. 1. Assign the role **Secret Manager Secret Accessor**.
......
...@@ -84,7 +84,7 @@ In each example, replace: ...@@ -84,7 +84,7 @@ In each example, replace:
- `<token>` with your trigger token. - `<token>` with your trigger token.
- `<ref_name>` with a branch or tag name, like `main`. - `<ref_name>` with a branch or tag name, like `main`.
- `<project_id>` with your project ID, like `123456`. The project ID is displayed - `<project_id>` with your project ID, like `123456`. The project ID is displayed
on the [project overview page](../../user/project/working_with_projects.md#access-the-project-overview-page-by-using-the-project-id). on the [project overview page](../../user/project/working_with_projects.md#access-a-project-by-using-the-project-id).
### Use a CI/CD job ### Use a CI/CD job
...@@ -107,7 +107,7 @@ trigger_pipeline: ...@@ -107,7 +107,7 @@ trigger_pipeline:
In this example: In this example:
- `1234` is the project ID for `project-B`. The project ID is displayed on the - `1234` is the project ID for `project-B`. The project ID is displayed on the
[project overview page](../../user/project/working_with_projects.md#access-the-project-overview-page-by-using-the-project-id). [project overview page](../../user/project/working_with_projects.md#access-a-project-by-using-the-project-id).
- The [`rules`](../yaml/index.md#rules) cause the job to run every time a tag is added to `project-A`. - The [`rules`](../yaml/index.md#rules) cause the job to run every time a tag is added to `project-A`.
- `MY_TRIGGER_TOKEN` is a [masked CI/CD variables](../variables/index.md#mask-a-cicd-variable) - `MY_TRIGGER_TOKEN` is a [masked CI/CD variables](../variables/index.md#mask-a-cicd-variable)
that contains the trigger token. that contains the trigger token.
...@@ -125,7 +125,7 @@ Replace: ...@@ -125,7 +125,7 @@ Replace:
- The URL with `https://gitlab.com` or the URL of your instance. - The URL with `https://gitlab.com` or the URL of your instance.
- `<project_id>` with your project ID, like `123456`. The project ID is displayed - `<project_id>` with your project ID, like `123456`. The project ID is displayed
on the [project overview page](../../user/project/working_with_projects.md#access-the-project-overview-page-by-using-the-project-id). on the [project overview page](../../user/project/working_with_projects.md#access-a-project-by-using-the-project-id).
- `<ref_name>` with a branch or tag name, like `main`. This value takes precedence over the `ref_name` in the webhook payload. - `<ref_name>` with a branch or tag name, like `main`. This value takes precedence over the `ref_name` in the webhook payload.
The payload's `ref` is the branch that fired the trigger in the source repository. The payload's `ref` is the branch that fired the trigger in the source repository.
You must URL-encode the `ref_name` if it contains slashes. You must URL-encode the `ref_name` if it contains slashes.
......
...@@ -124,7 +124,7 @@ Don't expose it to the public. If it is leaked or exposed, rotate the Sentry DSN ...@@ -124,7 +124,7 @@ Don't expose it to the public. If it is leaked or exposed, rotate the Sentry DSN
Prerequisites: Prerequisites:
- You need the numeric [project ID](../user/project/working_with_projects.md#access-the-project-overview-page-by-using-the-project-id) - You need the numeric [project ID](../user/project/working_with_projects.md#access-a-project-by-using-the-project-id)
for your project. for your project.
To rotate the Sentry DSN: To rotate the Sentry DSN:
......
...@@ -40,7 +40,7 @@ Prerequisites: ...@@ -40,7 +40,7 @@ Prerequisites:
error (`Validation failed: Version is invalid`) occurs when you publish. error (`Validation failed: Version is invalid`) occurs when you publish.
- A valid `composer.json` file at the project root directory. - A valid `composer.json` file at the project root directory.
- The Packages feature is enabled in a GitLab repository. - The Packages feature is enabled in a GitLab repository.
- The project ID, which is displayed on the [project overview page](../../project/working_with_projects.md#access-the-project-overview-page-by-using-the-project-id). - The project ID, which is displayed on the [project overview page](../../project/working_with_projects.md#access-a-project-by-using-the-project-id).
- One of the following token types: - One of the following token types:
- A [personal access token](../../../user/profile/personal_access_tokens.md) with the scope set to `api`. - A [personal access token](../../../user/profile/personal_access_tokens.md) with the scope set to `api`.
- A [deploy token](../../project/deploy_tokens/index.md) - A [deploy token](../../project/deploy_tokens/index.md)
......
...@@ -185,7 +185,7 @@ Prerequisites: ...@@ -185,7 +185,7 @@ Prerequisites:
- A local [Conan package](https://docs.conan.io/en/latest/creating_packages/getting_started.html) - A local [Conan package](https://docs.conan.io/en/latest/creating_packages/getting_started.html)
must exist. must exist.
- For an instance remote, the package must meet the [naming convention](#package-recipe-naming-convention-for-instance-remotes). - For an instance remote, the package must meet the [naming convention](#package-recipe-naming-convention-for-instance-remotes).
- You must have the project ID, which is displayed on the [project overview page](../../project/working_with_projects.md#access-the-project-overview-page-by-using-the-project-id). - You must have the project ID, which is displayed on the [project overview page](../../project/working_with_projects.md#access-a-project-by-using-the-project-id).
To publish the package, use the `conan upload` command: To publish the package, use the `conan upload` command:
......
...@@ -293,7 +293,7 @@ For the instance-level endpoint, ensure the relevant section of your `pom.xml` i ...@@ -293,7 +293,7 @@ For the instance-level endpoint, ensure the relevant section of your `pom.xml` i
| Endpoint | Endpoint URL for `pom.xml` | Additional information | | Endpoint | Endpoint URL for `pom.xml` | Additional information |
|----------|--------------------------------------------------------------------------|------------------------| |----------|--------------------------------------------------------------------------|------------------------|
| Project | `https://gitlab.example.com/api/v4/projects/<project_id>/packages/maven` | Replace `gitlab.example.com` with your domain name. Replace `<project_id>` with your project ID, found on your [project overview page](../../project/working_with_projects.md#access-the-project-overview-page-by-using-the-project-id). | | Project | `https://gitlab.example.com/api/v4/projects/<project_id>/packages/maven` | Replace `gitlab.example.com` with your domain name. Replace `<project_id>` with your project ID, found on your [project overview page](../../project/working_with_projects.md#access-a-project-by-using-the-project-id). |
| Group | `https://gitlab.example.com/api/v4/groups/<group_id>/-/packages/maven` | Replace `gitlab.example.com` with your domain name. Replace `<group_id>` with your group ID, found on your group's homepage. | | Group | `https://gitlab.example.com/api/v4/groups/<group_id>/-/packages/maven` | Replace `gitlab.example.com` with your domain name. Replace `<group_id>` with your group ID, found on your group's homepage. |
| Instance | `https://gitlab.example.com/api/v4/packages/maven` | Replace `gitlab.example.com` with your domain name. | | Instance | `https://gitlab.example.com/api/v4/packages/maven` | Replace `gitlab.example.com` with your domain name. |
......
...@@ -70,7 +70,7 @@ Create or edit the `.npmrc` file in the same directory as your `package.json`. I ...@@ -70,7 +70,7 @@ Create or edit the `.npmrc` file in the same directory as your `package.json`. I
- Replace `@scope` with the [root level group](#naming-convention) of the project you're publishing to the package to. - Replace `@scope` with the [root level group](#naming-convention) of the project you're publishing to the package to.
- Replace `your_domain_name` with your domain name, for example, `gitlab.com`. - Replace `your_domain_name` with your domain name, for example, `gitlab.com`.
- Replace `your_project_id` is your project ID, found on the [project overview page](../../project/working_with_projects.md#access-the-project-overview-page-by-using-the-project-id). - Replace `your_project_id` with your project ID, found on the [project overview page](../../project/working_with_projects.md#access-a-project-by-using-the-project-id).
- `"${NPM_TOKEN}"` is associated with the token you created later in the process. - `"${NPM_TOKEN}"` is associated with the token you created later in the process.
WARNING: WARNING:
...@@ -166,7 +166,7 @@ In these examples: ...@@ -166,7 +166,7 @@ In these examples:
- Replace `your_domain_name` with your domain name, for example, `gitlab.com`. - Replace `your_domain_name` with your domain name, for example, `gitlab.com`.
- Replace `your_group_id` with your group ID, found on the group's home page. - Replace `your_group_id` with your group ID, found on the group's home page.
- Replace `your_project_id` is your project ID, found on the [project overview page](../../project/working_with_projects.md#access-the-project-overview-page-by-using-the-project-id). - Replace `your_project_id` with your project ID, found on the [project overview page](../../project/working_with_projects.md#access-a-project-by-using-the-project-id).
- Replace `your_token` with a deploy token, group access token, project access token, or personal access token. - Replace `your_token` with a deploy token, group access token, project access token, or personal access token.
NOTE: NOTE:
...@@ -232,7 +232,7 @@ To install a package from the instance level, the package must have been publish ...@@ -232,7 +232,7 @@ To install a package from the instance level, the package must have been publish
- Replace `@scope` with the [root level group](#naming-convention) of the project you're installing to the package from. - Replace `@scope` with the [root level group](#naming-convention) of the project you're installing to the package from.
- Replace `your_domain_name` with your domain name, for example, `gitlab.com`. - Replace `your_domain_name` with your domain name, for example, `gitlab.com`.
- Replace `your_project_id` is your project ID, found on the [project overview page](../../project/working_with_projects.md#access-the-project-overview-page-by-using-the-project-id). - Replace `your_project_id` with your project ID, found on the [project overview page](../../project/working_with_projects.md#access-a-project-by-using-the-project-id).
1. Install the package 1. Install the package
......
...@@ -59,7 +59,7 @@ Prerequisites: ...@@ -59,7 +59,7 @@ Prerequisites:
both. both.
- A name for your source. - A name for your source.
- Depending on the [endpoint level](#use-the-gitlab-endpoint-for-nuget-packages) you use, either: - Depending on the [endpoint level](#use-the-gitlab-endpoint-for-nuget-packages) you use, either:
- Your project ID, which is found on your [project overview page](../../project/working_with_projects.md#access-the-project-overview-page-by-using-the-project-id). - Your project ID, which is found on your [project overview page](../../project/working_with_projects.md#access-a-project-by-using-the-project-id).
- Your group ID, which is found on your group's home page. - Your group ID, which is found on your group's home page.
You can now add a new source to NuGet with: You can now add a new source to NuGet with:
......
...@@ -74,7 +74,7 @@ https://gitlab.example.com/api/v4/projects/<project_id>/packages/rubygems: '<you ...@@ -74,7 +74,7 @@ https://gitlab.example.com/api/v4/projects/<project_id>/packages/rubygems: '<you
``` ```
- `<your token>` must be the token value of either your personal access token or deploy token. - `<your token>` must be the token value of either your personal access token or deploy token.
- Your project ID is displayed on the [project overview page](../../project/working_with_projects.md#access-the-project-overview-page-by-using-the-project-id). - Your project ID is displayed on the [project overview page](../../project/working_with_projects.md#access-a-project-by-using-the-project-id).
### Authenticate with a CI job token ### Authenticate with a CI job token
......
...@@ -48,7 +48,7 @@ In this configuration: ...@@ -48,7 +48,7 @@ In this configuration:
- Replace `<my-org>` with your organization scope, exclude the `@` symbol. - Replace `<my-org>` with your organization scope, exclude the `@` symbol.
- Replace `<your_domain>` with your domain name. - Replace `<your_domain>` with your domain name.
- Replace `<your_project_id>` with your project's ID, which you can find on the [project overview page](../../project/working_with_projects.md#access-the-project-overview-page-by-using-the-project-id). - Replace `<your_project_id>` with your project's ID, which you can find on the [project overview page](../../project/working_with_projects.md#access-a-project-by-using-the-project-id).
- Replace `<your_token>` with a deployment token, group access token, project access token, or personal access token. - Replace `<your_token>` with a deployment token, group access token, project access token, or personal access token.
Scoped registry does not work in Yarn Classic in `package.json` file, based on Scoped registry does not work in Yarn Classic in `package.json` file, based on
...@@ -251,7 +251,7 @@ Use these steps for each project in the `.yarnrc.yml` file: ...@@ -251,7 +251,7 @@ Use these steps for each project in the `.yarnrc.yml` file:
- Replace `<my-org>` with the root level group of the project you're installing to the package from excluding the `@` symbol. - Replace `<my-org>` with the root level group of the project you're installing to the package from excluding the `@` symbol.
- Replace `<your_domain_name>` with your domain name, for example, `gitlab.com`. - Replace `<your_domain_name>` with your domain name, for example, `gitlab.com`.
- Replace `<your_project_id>` with your project ID, found on the [project overview page](../../project/working_with_projects.md#access-the-project-overview-page-by-using-the-project-id). - Replace `<your_project_id>` with your project ID, found on the [project overview page](../../project/working_with_projects.md#access-a-project-by-using-the-project-id).
#### Set the registry (project level) #### Set the registry (project level)
...@@ -266,7 +266,7 @@ npmRegistries: ...@@ -266,7 +266,7 @@ npmRegistries:
- Replace `<your_domain_name>` with your domain name, for example, `gitlab.com`. - Replace `<your_domain_name>` with your domain name, for example, `gitlab.com`.
- Replace `<your_token>` with a deployment token (recommended), group access token, project access token, or personal access token. - Replace `<your_token>` with a deployment token (recommended), group access token, project access token, or personal access token.
- Replace `<your_project_id>` with your project ID, found on the [project overview page](../../project/working_with_projects.md#access-the-project-overview-page-by-using-the-project-id). - Replace `<your_project_id>` with your project ID, found on the [project overview page](../../project/working_with_projects.md#access-a-project-by-using-the-project-id).
### Install the package ### Install the package
......
...@@ -13,6 +13,58 @@ DETAILS: ...@@ -13,6 +13,58 @@ DETAILS:
Most work in GitLab is done in a [project](../../user/project/index.md). Files and Most work in GitLab is done in a [project](../../user/project/index.md). Files and
code are saved in projects, and most features are in the scope of projects. code are saved in projects, and most features are in the scope of projects.
## Project overview
> - Project creation date [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/19452) in GitLab 16.10.
When you select a project, the **Project overview** page shows the project contents:
- Files in the repository
- Project information (description)
- Topics
- Badges
- Number of stars, forks, commits, branches, tags, releases, and environments in the project
- Project storage size
- Optional files and configurations
- `README` or index file
- Wiki page
- License
- Changelog
- Contributing guidelines
- Kubernetes cluster
- CI/CD configuration
- Integrations
- GitLab Pages
- Creation date
For public projects, and members of internal and private projects
with [permissions to view the project's code](../permissions.md#project-members-permissions),
the project overview page shows:
- A [`README` or index file](repository/files/index.md#readme-and-index-files).
- A list of directories in the project's repository.
For users without permission to view the project's code, the overview page shows:
- The wiki homepage.
- The list of issues in the project.
### Access a project by using the project ID
> - Project ID [moved](https://gitlab.com/gitlab-org/gitlab/-/issues/431539) to the Actions menu in GitLab 16.7.
You can access a project by using its ID instead of its name at `https://gitlab.example.com/projects/<id>`.
For example, if in your personal namespace `alex` you have a project `my-project` with the ID `123456`,
you can access the project either at `https://gitlab.example.com/alex/my-project` or `https://gitlab.example.com/projects/123456`.
You might also need the project ID if you want to interact with the project using the [GitLab API](../../api/index.md).
To copy the project ID:
1. On the left sidebar, select **Search or go to** and find your project.
1. On the project overview page, in the upper-right corner, select **Actions** (**{ellipsis_v}**).
1. Select **Copy project ID**.
## View all projects for the instance ## View all projects for the instance
To view all projects for the GitLab instance: To view all projects for the GitLab instance:
...@@ -316,40 +368,6 @@ To rename a repository: ...@@ -316,40 +368,6 @@ To rename a repository:
1. In the **Change path** text box, edit the path. 1. In the **Change path** text box, edit the path.
1. Select **Change path**. 1. Select **Change path**.
## Access the project overview page by using the project ID
> - Project ID [moved](https://gitlab.com/gitlab-org/gitlab/-/issues/431539) to the Actions menu in GitLab 16.7.
To access a project by using the project ID instead of its name,
go to `https://gitlab.example.com/projects/<id>`.
To copy the project ID:
1. On the left sidebar, select **Search or go to** and find your project.
1. On the project overview page, in the upper-right corner, select **Actions** (**{ellipsis_v}**).
1. Select **Copy project ID**.
For example, if in your personal namespace `alex` you have a project `my-project` with the ID `123456`, you can access the project
either at `https://gitlab.example.com/alex/my-project` or `https://gitlab.example.com/projects/123456`.
You might also need the project ID if you want to interact with it using the [GitLab API](../../api/index.md).
## Who can view the Project overview page
When you select a project, the **Project overview** page shows the project contents.
For public projects, and members of internal and private projects
with [permissions to view the project's code](../permissions.md#project-members-permissions),
the project landing page shows:
- A [`README` or index file](repository/files/index.md#readme-and-index-files).
- A list of directories in the project's repository.
For users without permission to view the project's code, the landing page shows:
- The wiki homepage.
- The list of issues in the project.
## Leave a project ## Leave a project
> - The button to leave a project [moved](https://gitlab.com/gitlab-org/gitlab/-/issues/431539) to the Actions menu in GitLab 16.7. > - The button to leave a project [moved](https://gitlab.com/gitlab-org/gitlab/-/issues/431539) to the Actions menu in GitLab 16.7.
......
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