diff --git a/doc/ci/components/index.md b/doc/ci/components/index.md index bd8f0f49b975489532d4674c4ddda5e8e613df2d..708e5f7f0d1990864fc571787f5bf09cff09b74d 100644 --- a/doc/ci/components/index.md +++ b/doc/ci/components/index.md @@ -52,7 +52,7 @@ To create a component project, you must: 1. [Create a new project](../../user/project/index.md#create-a-blank-project) with a `README.md` file: - Ensure the description gives a clear introduction to the component. - - Optional. After the project is created, you can [add a project avatar](../../user/project/working_with_projects.md#edit-project-name-and-description). + - Optional. After the project is created, you can [add a project avatar](../../user/project/working_with_projects.md#edit-project-name-description-and-avatar). Components published to the [CI/CD catalog](#cicd-catalog) use both the description and avatar when displaying the component project's summary. @@ -239,7 +239,7 @@ Prerequisites: - The project must: - Be set as a [catalog project](#set-a-component-project-as-a-catalog-project). - - Have a [project description](../../user/project/working_with_projects.md#edit-project-name-and-description) defined. + - Have a [project description](../../user/project/working_with_projects.md#edit-project-name-description-and-avatar) defined. - Have a `README.md` file in the root directory for the commit SHA of the tag being released. - Have at least one [CI/CD component in the `templates/` directory](#directory-structure) for the commit SHA of the tag being released. @@ -623,7 +623,7 @@ To mirror a GitLab.com component in your self-managed instance: 1. Make sure that [network outbound requests](../../security/webhooks.md) are allowed for `gitlab.com`. 1. [Create a group](../../user/group/index.md#create-a-group) to host the component projects (recommended group: `components`). 1. [Create a mirror of the component project](../../user/project/repository/mirror/index.md) in the new group. -1. Write a [project description](../../user/project/working_with_projects.md#edit-project-name-and-description) +1. Write a [project description](../../user/project/working_with_projects.md#edit-project-name-description-and-avatar) for the component project mirror because mirroring repositories does not copy the description. 1. [Set the self-hosted component project as a catalog resource](#set-a-component-project-as-a-catalog-project). 1. Publish [a new release](../../user/project/releases/index.md) in the self-hosted component project by diff --git a/doc/user/project/working_with_projects.md b/doc/user/project/working_with_projects.md index 529c1a91203226119d964fb15202040c993b689c..75a93df821243e5e6f1b043cb15e3cc21d20308c 100644 --- a/doc/user/project/working_with_projects.md +++ b/doc/user/project/working_with_projects.md @@ -54,7 +54,7 @@ To view projects you have [starred](#star-a-project): 1. On the left sidebar, select your avatar and then your username. 1. On the left sidebar, select **Starred projects**. -## Edit project name and description +## Edit project name, description, and avatar Use the project general settings to edit your project details. @@ -65,8 +65,9 @@ Prerequisites: 1. On the left sidebar, select **Search or go to** and find your project. 1. Select **Settings > General**. 1. In the **Project name** text box, enter your project name. See the [limitations on project names](../../user/reserved_names.md). -1. In the **Project description** text box, enter your project description. The description is limited to 2,000 characters. -1. Under **Project avatar**, to change your project avatar, select **Choose file**. +1. Optional. In the **Project description** text box, enter your project description. The description is limited to 2,000 characters. +1. Optional. Under **Project avatar**, to change your project avatar, select **Choose file**. The ideal image size is 192 x 192 pixels, and the maximum file size allowed is 200 KB. +1. Select **Save changes**. ## Star a project