Commit 1706b84f authored by Craig Norris's avatar Craig Norris

Merge branch '333189-aqualls-left-nav-docs' into 'master'

Update instructions for Project information page

See merge request gitlab-org/gitlab!63697
parents 50249cac 30c34606
...@@ -21,7 +21,7 @@ If you are migrating from another CI/CD tool, view this documentation: ...@@ -21,7 +21,7 @@ If you are migrating from another CI/CD tool, view this documentation:
- [Migrate from Jenkins](../migration/jenkins.md). - [Migrate from Jenkins](../migration/jenkins.md).
> - <i class="fa fa-youtube-play youtube" aria-hidden="true"></i>&nbsp;Watch [First time GitLab & CI/CD](https://www.youtube.com/watch?v=kTNfi5z6Uvk&t=553s). This includes a quick introduction to GitLab, the first steps with CI/CD, building a Go project, running tests, using the CI/CD pipeline editor, detecting secrets and security vulnerabilities and offers more exercises for async practice. > - <i class="fa fa-youtube-play youtube" aria-hidden="true"></i>&nbsp;Watch [First time GitLab & CI/CD](https://www.youtube.com/watch?v=kTNfi5z6Uvk&t=553s). This includes a quick introduction to GitLab, the first steps with CI/CD, building a Go project, running tests, using the CI/CD pipeline editor, detecting secrets and security vulnerabilities and offers more exercises for async practice.
> - <i class="fa fa-youtube-play youtube" aria-hidden="true"></i>&nbsp;Watch [Intro to GitLab CI](https://www.youtube.com/watch?v=l5705U8s_nQ&t=358s). This workshop uses the Web IDE to quickly get going with building source code using CI/CD, and run unit tests. > - <i class="fa fa-youtube-play youtube" aria-hidden="true"></i>&nbsp;Watch [Intro to GitLab CI](https://www.youtube.com/watch?v=l5705U8s_nQ&t=358s). This workshop uses the Web IDE to quickly get going with building source code using CI/CD, and run unit tests.
## CI/CD process overview ## CI/CD process overview
...@@ -76,7 +76,7 @@ All of this is defined in the `.gitlab-ci.yml` file. ...@@ -76,7 +76,7 @@ All of this is defined in the `.gitlab-ci.yml` file.
To create a `.gitlab-ci.yml` file: To create a `.gitlab-ci.yml` file:
1. Go to **Project overview > Details**. 1. On the left sidebar, select **Project information > Details**.
1. Above the file list, select the branch you want to commit to, 1. Above the file list, select the branch you want to commit to,
click the plus icon, then select **New file**: click the plus icon, then select **New file**:
......
...@@ -1383,10 +1383,10 @@ readability of the text. ...@@ -1383,10 +1383,10 @@ readability of the text.
For example, this Markdown adds little to the accompanying text: For example, this Markdown adds little to the accompanying text:
```markdown ```markdown
1. Go to **{home}** **Project overview > Details**. 1. Go to **{home}** **Project information > Details**.
``` ```
1. Go to **{home}** **Project overview > Details**. 1. Go to **{home}** **Project information > Details**.
However, these tables might help the reader connect the text to the user However, these tables might help the reader connect the text to the user
interface: interface:
......
...@@ -165,12 +165,12 @@ To change the password for this customers portal account: ...@@ -165,12 +165,12 @@ To change the password for this customers portal account:
1. Make the required changes to the **Your password** section. 1. Make the required changes to the **Your password** section.
1. Click **Save changes**. 1. Click **Save changes**.
## Community program subscriptions ## Community program subscriptions
### GitLab for Education ### GitLab for Education
For qualifying non-profit educational institutions, the [GitLab for Education](https://about.gitlab.com/solutions/education/) program provides For qualifying non-profit educational institutions, the [GitLab for Education](https://about.gitlab.com/solutions/education/) program provides
the top GitLab tier, plus 50,000 CI minutes per month. the top GitLab tier, plus 50,000 CI minutes per month.
The GitLab for Education license can only be used for instructional-use or The GitLab for Education license can only be used for instructional-use or
non-commercial academic research. non-commercial academic research.
...@@ -180,8 +180,8 @@ Find more information on how to apply and renew at ...@@ -180,8 +180,8 @@ Find more information on how to apply and renew at
### GitLab for Open Source ### GitLab for Open Source
For qualifying open source projects, the [GitLab for Open Source](https://about.gitlab.com/solutions/open-source/) program provides For qualifying open source projects, the [GitLab for Open Source](https://about.gitlab.com/solutions/open-source/) program provides
the top GitLab tier, plus 50,000 CI minutes per month. the top GitLab tier, plus 50,000 CI minutes per month.
You can find more information about the [program requirements](https://about.gitlab.com/solutions/open-source/join/#requirements), You can find more information about the [program requirements](https://about.gitlab.com/solutions/open-source/join/#requirements),
[renewals](https://about.gitlab.com/solutions/open-source/join/$renewals), [renewals](https://about.gitlab.com/solutions/open-source/join/$renewals),
...@@ -211,13 +211,13 @@ After you ensure that you are using OSI-approved licenses for your projects, you ...@@ -211,13 +211,13 @@ After you ensure that you are using OSI-approved licenses for your projects, you
###### License overview ###### License overview
Go to **Project Overview > Details**. Take a screenshot that includes a view of the license you've chosen for your project. On the left sidebar, select **Project Information > Details**. Take a screenshot that includes a view of the license you've chosen for your project.
![License overview](img/license-overview.png) ![License overview](img/license-overview.png)
###### License file ###### License file
Navigate to one of the license files that you uploaded. You can usually find the license file by selecting **Project Overview > Details** and scanning the page for the license. Navigate to one of the license files that you uploaded. You can usually find the license file by selecting **Project Information > Details** and scanning the page for the license.
Make sure the screenshot includes the title of the license. Make sure the screenshot includes the title of the license.
![License file](img/license-file.png) ![License file](img/license-file.png)
...@@ -230,7 +230,7 @@ As a result, we ask that all projects under this license are publicly visible. ...@@ -230,7 +230,7 @@ As a result, we ask that all projects under this license are publicly visible.
Follow these instructions to take a screenshot of the publicly visible settings: Follow these instructions to take a screenshot of the publicly visible settings:
1. Go to your project and select **Settings**. 1. Go to your project and select **Settings**.
1. Expand **Visibility, project features, permissions**. 1. Expand **Visibility, project features, permissions**.
1. Set **Project Visibility** to **Public**. 1. Set **Project Visibility** to **Public**.
1. Ensure others can request access by selecting the **Users can request access** checkbox. 1. Ensure others can request access by selecting the **Users can request access** checkbox.
...@@ -241,14 +241,14 @@ Follow these instructions to take a screenshot of the publicly visible settings: ...@@ -241,14 +241,14 @@ Follow these instructions to take a screenshot of the publicly visible settings:
NOTE: NOTE:
From time to time, GitLab allows exceptions. One or two projects within a group can be private if there is a legitimate need for it, for example, From time to time, GitLab allows exceptions. One or two projects within a group can be private if there is a legitimate need for it, for example,
if a project holds sensitive data. Email `opensource@gitlab.com` with details of your use case to request written permission for exceptions. if a project holds sensitive data. Email `opensource@gitlab.com` with details of your use case to request written permission for exceptions.
### GitLab for Startups ### GitLab for Startups
For qualifying startups, the [GitLab for Startups](https://about.gitlab.com/solutions/startups/) program provides For qualifying startups, the [GitLab for Startups](https://about.gitlab.com/solutions/startups/) program provides
the top GitLab tier, plus 50,000 CI minutes per month for 12 months. the top GitLab tier, plus 50,000 CI minutes per month for 12 months.
For more information, including program requirements, see the [Startup program's landing page](https://about.gitlab.com/solutions/startups/). For more information, including program requirements, see the [Startup program's landing page](https://about.gitlab.com/solutions/startups/).
Send all questions and requests related to the GitLab for Startups program to `startups@gitlab.com`. Send all questions and requests related to the GitLab for Startups program to `startups@gitlab.com`.
...@@ -257,7 +257,7 @@ Send all questions and requests related to the GitLab for Startups program to `s ...@@ -257,7 +257,7 @@ Send all questions and requests related to the GitLab for Startups program to `s
Because these Community Programs are free of cost, regular Priority Support is not included. However, it can be purchased at a 95% discount in some cases. Because these Community Programs are free of cost, regular Priority Support is not included. However, it can be purchased at a 95% discount in some cases.
If interested, email the relevant community program team: `education@gitlab.com`, `opensource@gitlab.com`, or `startups@gitlab.com`. If interested, email the relevant community program team: `education@gitlab.com`, `opensource@gitlab.com`, or `startups@gitlab.com`.
As a community member, you can follow this diagram to find support: As a community member, you can follow this diagram to find support:
![Support diagram](img/support-diagram.png) ![Support diagram](img/support-diagram.png)
......
...@@ -131,7 +131,7 @@ To view the published package, go to **Packages & Registries > Package Registry* ...@@ -131,7 +131,7 @@ To view the published package, go to **Packages & Registries > Package Registry*
A more detailed Composer CI/CD file is also available as a `.gitlab-ci.yml` template: A more detailed Composer CI/CD file is also available as a `.gitlab-ci.yml` template:
1. On the left sidebar, click **Project overview**. 1. On the left sidebar, select **Project information**.
1. Above the file list, click **Set up CI/CD**. If this button is not available, select **CI/CD Configuration** and then **Edit**. 1. Above the file list, click **Set up CI/CD**. If this button is not available, select **CI/CD Configuration** and then **Edit**.
1. From the **Apply a template** list, select **Composer**. 1. From the **Apply a template** list, select **Composer**.
......
...@@ -34,8 +34,8 @@ of each package management system to publish different package types to the same ...@@ -34,8 +34,8 @@ of each package management system to publish different package types to the same
Let's take a look at how you might create a public place to hold all of your public packages. Let's take a look at how you might create a public place to hold all of your public packages.
1. Create a new project in GitLab. The project doesn't require any code or content. Note the project ID 1. Create a new project in GitLab. The project doesn't require any code or content.
that's displayed on the project overview page. 1. On the left sidebar, select **Project information**, and note the project ID.
1. Create an access token. All package types in the Package Registry are accessible by using 1. Create an access token. All package types in the Package Registry are accessible by using
[GitLab personal access tokens](../../profile/personal_access_tokens.md). [GitLab personal access tokens](../../profile/personal_access_tokens.md).
If you're using CI/CD, you can use CI job tokens (`CI_JOB_TOKEN`) to authenticate. If you're using CI/CD, you can use CI job tokens (`CI_JOB_TOKEN`) to authenticate.
......
...@@ -15,7 +15,7 @@ points to. Examples for badges can be the [pipeline status](../../ci/pipelines/s ...@@ -15,7 +15,7 @@ points to. Examples for badges can be the [pipeline status](../../ci/pipelines/s
[test coverage](../../ci/pipelines/settings.md#test-coverage-report-badge), or ways to contact the [test coverage](../../ci/pipelines/settings.md#test-coverage-report-badge), or ways to contact the
project maintainers. project maintainers.
![Badges on Project overview page](img/project_overview_badges_v13_10.png) ![Badges on Project information page](img/project_overview_badges_v13_10.png)
## Project badges ## Project badges
......
...@@ -97,7 +97,7 @@ Projects include the following [features](https://about.gitlab.com/features/): ...@@ -97,7 +97,7 @@ Projects include the following [features](https://about.gitlab.com/features/):
- [Security Dashboard](../application_security/security_dashboard/index.md) **(ULTIMATE)** - [Security Dashboard](../application_security/security_dashboard/index.md) **(ULTIMATE)**
- [Syntax highlighting](highlighting.md): Customize - [Syntax highlighting](highlighting.md): Customize
your code blocks, overriding the default language choice. your code blocks, overriding the default language choice.
- [Badges](badges.md): Add an image to the project overview. - [Badges](badges.md): Add an image to the **Project information** page.
- [Releases](releases/index.md): Take a snapshot of - [Releases](releases/index.md): Take a snapshot of
the source, build output, metadata, and artifacts the source, build output, metadata, and artifacts
associated with a released version of your code. associated with a released version of your code.
......
...@@ -17,7 +17,7 @@ Your GitLab repository should contain files specific to an SSG, or plain HTML. ...@@ -17,7 +17,7 @@ Your GitLab repository should contain files specific to an SSG, or plain HTML.
After you complete these steps, you may need to do additional After you complete these steps, you may need to do additional
configuration for the Pages site to generate properly. configuration for the Pages site to generate properly.
1. In the left sidebar, click **Project overview**. 1. On the left sidebar, select **Project information**.
1. Click **Set up CI/CD**. 1. Click **Set up CI/CD**.
![setup GitLab CI/CD](../img/setup_ci_v13_1.png) ![setup GitLab CI/CD](../img/setup_ci_v13_1.png)
......
...@@ -33,7 +33,7 @@ and attach [release assets](#release-assets), like runbooks or packages. ...@@ -33,7 +33,7 @@ and attach [release assets](#release-assets), like runbooks or packages.
To view a list of releases: To view a list of releases:
- Go to **Project overview > Releases**, or - On the left sidebar, select **Project information > Releases**, or
- On the project's overview page, if at least one release exists, click the number of releases. - On the project's overview page, if at least one release exists, click the number of releases.
...@@ -64,8 +64,7 @@ Read more about [Release permissions](../../../user/permissions.md#project-membe ...@@ -64,8 +64,7 @@ Read more about [Release permissions](../../../user/permissions.md#project-membe
To create a new release through the GitLab UI: To create a new release through the GitLab UI:
1. Navigate to **Project overview > Releases** and click the **New release** 1. On the left sidebar, select **Project information > Releases** and select **New release**.
button.
1. Open the [**Tag name**](#tag-name) dropdown. Select an existing tag or type 1. Open the [**Tag name**](#tag-name) dropdown. Select an existing tag or type
in a new tag name. Selecting an existing tag that is already associated with in a new tag name. Selecting an existing tag that is already associated with
a release will result in a validation error. a release will result in a validation error.
...@@ -105,7 +104,7 @@ Read more about [Release permissions](../../../user/permissions.md#project-membe ...@@ -105,7 +104,7 @@ Read more about [Release permissions](../../../user/permissions.md#project-membe
To edit the details of a release: To edit the details of a release:
1. Navigate to **Project overview > Releases**. 1. On the left sidebar, select **Project information > Releases**.
1. In the top-right corner of the release you want to modify, click **Edit this release** (the pencil icon). 1. In the top-right corner of the release you want to modify, click **Edit this release** (the pencil icon).
1. On the **Edit Release** page, change the release's details. 1. On the **Edit Release** page, change the release's details.
1. Click **Save changes**. 1. Click **Save changes**.
...@@ -151,12 +150,12 @@ the [Releases API](../../../api/releases/index.md#create-a-release). ...@@ -151,12 +150,12 @@ the [Releases API](../../../api/releases/index.md#create-a-release).
In the user interface, to associate milestones to a release: In the user interface, to associate milestones to a release:
1. Navigate to **Project overview > Releases**. 1. On the left sidebar, select **Project information > Releases**.
1. In the top-right corner of the release you want to modify, click **Edit this release** (the pencil icon). 1. In the top-right corner of the release you want to modify, click **Edit this release** (the pencil icon).
1. From the **Milestones** list, select each milestone you want to associate. You can select multiple milestones. 1. From the **Milestones** list, select each milestone you want to associate. You can select multiple milestones.
1. Click **Save changes**. 1. Click **Save changes**.
On the **Project overview > Releases** page, the **Milestone** is listed in the top On the **Project information > Releases** page, the **Milestone** is listed in the top
section, along with statistics about the issues in the milestones. section, along with statistics about the issues in the milestones.
![A Release with one associated milestone](img/release_with_milestone_v12_9.png) ![A Release with one associated milestone](img/release_with_milestone_v12_9.png)
...@@ -176,7 +175,7 @@ You can be notified by email when a new release is created for your project. ...@@ -176,7 +175,7 @@ You can be notified by email when a new release is created for your project.
To subscribe to notifications for releases: To subscribe to notifications for releases:
1. Navigate to **Project overview**. 1. On the left sidebar, select **Project information**.
1. Click **Notification setting** (the bell icon). 1. Click **Notification setting** (the bell icon).
1. In the list, click **Custom**. 1. In the list, click **Custom**.
1. Select the **New release** check box. 1. Select the **New release** check box.
...@@ -210,7 +209,7 @@ deploy_to_production: ...@@ -210,7 +209,7 @@ deploy_to_production:
To set a deploy freeze window in the UI, complete these steps: To set a deploy freeze window in the UI, complete these steps:
1. Sign in to GitLab as a user with the [Maintainer role](../../permissions.md). 1. Sign in to GitLab as a user with the [Maintainer role](../../permissions.md).
1. Navigate to **Project overview**. 1. On the left sidebar, select **Project information**.
1. In the left navigation menu, navigate to **Settings > CI/CD**. 1. In the left navigation menu, navigate to **Settings > CI/CD**.
1. Scroll to **Deploy freezes**. 1. Scroll to **Deploy freezes**.
1. Click **Expand** to see the deploy freeze table. 1. Click **Expand** to see the deploy freeze table.
......
...@@ -113,7 +113,7 @@ You can download the source code that's stored in a repository. ...@@ -113,7 +113,7 @@ You can download the source code that's stored in a repository.
## Repository languages ## Repository languages
For the default branch of each repository, GitLab determines which programming languages For the default branch of each repository, GitLab determines which programming languages
are used. This information is displayed on the project overview page. are used. This information is displayed on the **Project information** page.
![Repository Languages bar](img/repository_languages_v12_2.gif) ![Repository Languages bar](img/repository_languages_v12_2.gif)
...@@ -121,7 +121,7 @@ When new files are added, this information can take up to five minutes to update ...@@ -121,7 +121,7 @@ When new files are added, this information can take up to five minutes to update
### Add repository languages ### Add repository languages
Not all files are detected and listed on the project overview page. Documentation, Not all files are detected and listed on the **Project information** page. Documentation,
vendor code, and most markup languages are excluded. vendor code, and most markup languages are excluded.
You can change this behavior by overriding the default settings. You can change this behavior by overriding the default settings.
...@@ -200,7 +200,7 @@ To render an OpenAPI file: ...@@ -200,7 +200,7 @@ To render an OpenAPI file:
## Repository size ## Repository size
The project overview page shows the size of all files in the repository. The size is The **Project information** page shows the size of all files in the repository. The size is
updated, at most, every 15 minutes. The file size includes repository files, artifacts, and LFS. updated, at most, every 15 minutes. The file size includes repository files, artifacts, and LFS.
The size can differ slightly from one instance to another due to compression, housekeeping, and other factors. The size can differ slightly from one instance to another due to compression, housekeeping, and other factors.
......
...@@ -228,10 +228,16 @@ Read through the documentation on [project settings](settings/index.md). ...@@ -228,10 +228,16 @@ Read through the documentation on [project settings](settings/index.md).
## Project activity ## Project activity
To view the activity of a project, navigate to **Project overview > Activity**. To view the activity of a project:
From there, you can click on the tabs to see **All** the activity, or see it
filtered by **Push events**, **Merge events**, **Issue events**, **Comments**, 1. On the left sidebar, select **Project information > Activity**.
**Team**, and **Wiki**. 1. Select a tab to view **All** the activity, or to filter it by any of these criteria:
- **Push events**
- **Merge events**
- **Issue events**
- **Comments**
- **Team**
- **Wiki**
### Leave a project ### Leave a project
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment