diff --git a/doc/user/application_security/secret_detection/index.md b/doc/user/application_security/secret_detection/index.md index 35526da46db..4339b5c499d 100644 --- a/doc/user/application_security/secret_detection/index.md +++ b/doc/user/application_security/secret_detection/index.md @@ -34,33 +34,8 @@ GitLab displays identified secrets visibly in a few places: ## Supported secrets Secret Detection detects a variety of common secrets by default. You can also customize the secret detection patterns using [custom rulesets](#custom-rulesets). - -The [default ruleset provided by TruffleHog and Gitleaks](https://gitlab.com/gitlab-org/security-products/analyzers/secrets/-/blob/master/gitleaks.toml) includes the following key types: - -- Cloud services: - - Amazon Web Services (AWS) - - Google Cloud Platform (GCP) - - Heroku API -- Encryption keys: - - PKCS8 - - RSA - - SSH - - PGP - - DSA - - EC -- Social media platforms: - - Facebook API - - Twitter API -- Cloud SaaS vendors: - - GitHub API - - Shopify API - - Slack Token - - Slack Webhook - - Stripe API - - Twilio API - - Generic API key strings starting with `api-` -- Password in URL -- U.S. Social Security Number +The [default ruleset](https://gitlab.com/gitlab-org/security-products/analyzers/secrets/-/blob/master/gitleaks.toml) includes **90+ secret detection patterns**. +You can contribute "well-identifiable" secrets by follow the steps detailed in the [community contributions guidelines](https://gitlab.com/gitlab-org/gitlab/-/issues/345453). WARNING: Gitleaks does not support scanning binary files. diff --git a/doc/user/profile/index.md b/doc/user/profile/index.md index d9f10b58c3f..036a5890f4d 100644 --- a/doc/user/profile/index.md +++ b/doc/user/profile/index.md @@ -109,9 +109,12 @@ your profile's bio. To add a README to your profile: -1. Create a new public project with the same name as your GitLab username. +1. Create a new public project with the same project path as your GitLab username. 1. Create a README file inside this project. The file can be any valid [README or index file](../project/repository/index.md#readme-and-index-files). +To use an existing project, [update the path](../project/settings/index.md#renaming-a-repository) of the project to match +your username. + ## Add external accounts to your user profile page You can add links to certain other external accounts you might have, like Skype and Twitter. diff --git a/doc/user/project/repository/branches/default.md b/doc/user/project/repository/branches/default.md index bc6bc799670..65b7c4a9881 100644 --- a/doc/user/project/repository/branches/default.md +++ b/doc/user/project/repository/branches/default.md @@ -41,7 +41,7 @@ To update the default branch name for an individual [project](../../index.md): 1. Sign in to GitLab with at least the [Maintainer](../../../permissions.md) role. 1. In the left navigation menu, go to **Settings > Repository**. 1. Expand **Default branch**, and select a new default branch. -1. (Optional) Select the **Auto-close referenced issues on default branch** checkbox to close +1. Optional. Select the **Auto-close referenced issues on default branch** checkbox to close issues when a merge request [uses a closing pattern](../../issues/managing_issues.md#closing-issues-automatically). 1. Select **Save changes**. @@ -134,7 +134,7 @@ renames a Git repository's (`example`) default branch. [change the default branch for this project](#change-the-default-branch-name-for-a-project). Select `main` as your new default branch. 1. Protect your new `main` branch as described in the [protected branches documentation](../../protected_branches.md). -1. (Optional) If you want to delete the old default branch: +1. Optional. If you want to delete the old default branch: 1. Verify that nothing is pointing to it. 1. Delete the branch on the remote: diff --git a/doc/user/project/repository/gpg_signed_commits/index.md b/doc/user/project/repository/gpg_signed_commits/index.md index 4167d30cdab..94fe6ffac56 100644 --- a/doc/user/project/repository/gpg_signed_commits/index.md +++ b/doc/user/project/repository/gpg_signed_commits/index.md @@ -201,7 +201,7 @@ key to use. Replace `30F2B65B9246B6CA` with your GPG key ID. -1. (Optional) If Git is using `gpg` and you get errors like `secret key not available` +1. Optional. If Git is using `gpg` and you get errors like `secret key not available` or `gpg: signing failed: secret key not available`, run the following command to change to `gpg2`: diff --git a/doc/user/project/repository/web_editor.md b/doc/user/project/repository/web_editor.md index 8074f311e5f..ba105a970a7 100644 --- a/doc/user/project/repository/web_editor.md +++ b/doc/user/project/repository/web_editor.md @@ -175,10 +175,10 @@ request, you can create a new branch upfront. ![New branch dropdown](img/web_editor_new_branch_dropdown_v14_1.png) 1. Enter a new **Branch name**. -1. (Optional) Change the **Create from** field to choose which branch, tag, or +1. Optional. Change the **Create from** field to choose which branch, tag, or commit SHA this new branch originates from. This field autocompletes if you start typing an existing branch or tag. -1. Click **Create branch** to return to the file browser on this new branch. +1. To return to the file browser on this new branch, select **Create branch**. ![New branch page](img/web_editor_new_branch_page_v14_1.png) @@ -201,10 +201,10 @@ SHA: 1. Give the tag a name such as `v1.0.0`. 1. Choose the branch or SHA from which you want to create this new tag. -1. (Optional) Add a message and release notes. The release notes section supports +1. Optional. Add a message and release notes. The release notes section supports Markdown format. -1. (Optional) Upload an attachment. -1. Click **Create tag**, and GitLab redirects you to the tag list page. +1. Optional. Upload an attachment. +1. Select **Create tag**. GitLab redirects you to the tag list page. ![New tag page](img/web_editor_new_tag_page.png) diff --git a/doc/user/project/static_site_editor/index.md b/doc/user/project/static_site_editor/index.md index 431250a817d..78ca34b8f93 100644 --- a/doc/user/project/static_site_editor/index.md +++ b/doc/user/project/static_site_editor/index.md @@ -76,7 +76,7 @@ First, set up the project. Once done, you can use the Static Site Editor to 1. Edit the [`data/config.yml`](#static-site-generator-configuration) configuration file to replace `` and `` with the proper values for your project's path. -1. (Optional) Edit the [`.gitlab/static-site-editor.yml`](#static-site-editor-configuration-file) file +1. Optional. Edit the [`.gitlab/static-site-editor.yml`](#static-site-editor-configuration-file) file to customize the behavior of the Static Site Editor. 1. When you submit your changes, GitLab triggers a CI/CD pipeline to deploy your project with GitLab Pages. 1. When the pipeline finishes, from your project's left-side menu, go to **Settings > Pages** to find the URL of your new website. @@ -96,15 +96,15 @@ After setting up your project, you can start editing content directly from the S To edit a file: 1. Visit the page you want to edit. -1. Click the **Edit this page** button. +1. Select **Edit this page**. 1. The file is opened in the Static Site Editor in **WYSIWYG** mode. If you wish to edit the raw Markdown instead, you can toggle the **Markdown** mode in the bottom-right corner. 1. When you're done, click **Submit changes...**. -1. (Optional) Adjust the default title and description of the merge request, to submit +1. Optional. Adjust the default title and description of the merge request, to submit with your changes. Alternatively, select a [merge request template](../../../user/project/description_templates.md#create-a-merge-request-template) from the dropdown menu and edit it accordingly. -1. Click **Submit changes**. +1. Select **Submit changes**. 1. A new merge request is automatically created and you can assign a colleague for review. ### Text @@ -123,11 +123,11 @@ The Static Site Editors supports Markdown files (`.md`, `.md.erb`) for editing t You can upload image files via the WYSIWYG editor directly to the repository to default upload directory `source/images`. To do so: -1. Click the image icon (**{doc-image}**). -1. Choose the **Upload file** tab. -1. Click **Choose file** to select a file from your computer. -1. Optional: add a description to the image for SEO and accessibility ([ALT text](https://moz.com/learn/seo/alt-text)). -1. Click **Insert image**. +1. Select the image icon (**{doc-image}**). +1. Select the **Upload file** tab. +1. To select a file from your computer, select **Choose file**. +1. Optional. Add a description to the image for SEO and accessibility ([ALT text](https://moz.com/learn/seo/alt-text)). +1. Select **Insert image**. The selected file can be any supported image file (`.png`, `.jpg`, `.jpeg`, `.gif`). The editor renders thumbnail previews so you can verify the correct image is included and there aren't any references to @@ -137,11 +137,11 @@ missing images. You can also link to an image if you'd like: -1. Click the image icon (**{doc-image}**). -1. Choose the **Link to an image** tab. +1. Select the image icon (**{doc-image}**). +1. Select the **Link to an image** tab. 1. Add the link to the image into the **Image URL** field (use the full path; relative paths are not supported yet). -1. Optional: add a description to the image for SEO and accessibility ([ALT text](https://moz.com/learn/seo/alt-text)). -1. Click **Insert image**. +1. Optional. Add a description to the image for SEO and accessibility ([ALT text](https://moz.com/learn/seo/alt-text)). +1. Select **Insert image**. The link can reference images already hosted in your project, an asset hosted externally on a content delivery network, or any other external URL. The editor renders thumbnail previews diff --git a/doc/user/project/wiki/index.md b/doc/user/project/wiki/index.md index 5d2a0530f68..a82fed2754e 100644 --- a/doc/user/project/wiki/index.md +++ b/doc/user/project/wiki/index.md @@ -87,7 +87,7 @@ Users with the [Developer role](../../permissions.md) can create new wiki pages: [special characters](#special-characters-in-page-titles) for subdirectories and formatting, and have [length restrictions](#length-restrictions-for-file-and-directory-names). 1. Add content to your wiki page. -1. (Optional) Attach a file, and GitLab stores it according to your installed version of GitLab: +1. Optional. Attach a file, and GitLab stores it according to your installed version of GitLab: - *Files added in [GitLab 11.3 and later](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/33475):* Files are stored in the wiki's Git repository. - *Files added GitLab 11.2 and earlier:* Files are stored in GitLab itself. To add @@ -290,7 +290,7 @@ To add a link to an external wiki from a project's left sidebar: 1. On the left sidebar, select **Settings > Integrations**. 1. Select **External wiki**. 1. Add the URL to your external wiki. -1. (Optional) Select **Test settings** to verify the connection. +1. Optional. To verify the connection, select **Test settings**. 1. Select **Save changes**. You can now see the **External wiki** option from your project's