From 45acd04daecf28116faf08ed93f4740dfc563454 Mon Sep 17 00:00:00 2001
From: Ashraf Khamis <akhamis@gitlab.com>
Date: Mon, 25 Mar 2024 11:13:32 +0100
Subject: [PATCH 1/4] Use Markdown instead of HTML for footnotes
---
doc/api/groups.md | 10 +++-------
.../application_security/dependency_list/index.md | 12 ++++--------
doc/user/application_security/iac_scanning/index.md | 12 ++++--------
doc/user/application_security/sast/analyzers.md | 10 +++-------
doc/user/gitlab_duo_chat.md | 10 +++-------
doc/user/group/import/index.md | 10 +++-------
doc/user/project/members/index.md | 10 +++-------
7 files changed, 23 insertions(+), 51 deletions(-)
diff --git a/doc/api/groups.md b/doc/api/groups.md
index 509e1b199512a6..bcfbb5b2f1d2d1 100644
--- a/doc/api/groups.md
+++ b/doc/api/groups.md
@@ -331,13 +331,9 @@ Parameters:
| `with_custom_attributes` | boolean | no | Include [custom attributes](custom_attributes.md) in response (administrators only) |
| `with_security_reports` | boolean | no | Return only projects that have security reports artifacts present in any of their builds. This means "projects with security reports enabled". Default is `false`. Ultimate only. |
-<html>
-<small>Footnotes:
- <ol>
- <li>Order by similarity: Orders the results by a similarity score calculated from the provided <code>search</code> URL parameter. When using <code>order_by=similarity</code>, the <code>sort</code> parameter is ignored. When the <code>search</code> parameter is not provided, the API returns the projects ordered by <code>name</code>.</li>
- </ol>
-</small>
-</html>
+**Footnotes:**
+
+1. Order by similarity: Orders the results by a similarity score calculated from the provided `search` URL parameter. When using `order_by=similarity`, the `sort` parameter is ignored. When the `search` parameter is not provided, the API returns the projects ordered by `name`.
Example response:
diff --git a/doc/user/application_security/dependency_list/index.md b/doc/user/application_security/dependency_list/index.md
index ba695837c0fd0a..832f69c9b65afc 100644
--- a/doc/user/application_security/dependency_list/index.md
+++ b/doc/user/application_security/dependency_list/index.md
@@ -54,14 +54,10 @@ Details of each dependency are listed, sorted by decreasing severity of vulnerab
| License<sup>1</sup> | Links to dependency's software licenses. A warning badge that includes the number of vulnerabilities detected in the dependency. |
| Projects<sup>2</sup> | Links to the project with the dependency. If multiple projects have the same dependency, the total number of these projects is shown. To go to a project with this dependency, select the **Projects** number, then search for and select its name. The project search feature is supported only on groups that have up to 600 occurrences in their group hierarchy. |
-<html>
-<small>Footnotes:
- <ol>
- <li>Project-level only.</li>
- <li>Group-level only.</li>
- </ol>
-</small>
-</html>
+**Footnotes:**
+
+1. Project-level only
+1. Group-level only
diff --git a/doc/user/application_security/iac_scanning/index.md b/doc/user/application_security/iac_scanning/index.md
index 60f0952b4ee70c..529d648f64f562 100644
--- a/doc/user/application_security/iac_scanning/index.md
+++ b/doc/user/application_security/iac_scanning/index.md
@@ -73,14 +73,10 @@ Supported configuration formats:
- OpenAPI
- Terraform <sup>2</sup>
-<html>
-<small>Footnotes:
- <ol>
- <li>IaC Scanning can analyze Azure Resource Manager templates in JSON format. If you write templates in the <a href="https://learn.microsoft.com/en-us/azure/azure-resource-manager/bicep/overview">Bicep</a> language, you must use the <a href="https://learn.microsoft.com/en-us/azure/azure-resource-manager/bicep/bicep-cli">bicep CLI</a> to convert your Bicep files into JSON before IaC scanning can analyze them.</li>
- <li>Terraform modules in a custom registry are not scanned for vulnerabilities. You can follow <a href="https://gitlab.com/gitlab-org/gitlab/-/issues/357004">issue 357004</a> for the proposed feature.</li>
- </ol>
-</small>
-</html>
+**Footnotes:**
+
+1. IaC Scanning can analyze Azure Resource Manager templates in JSON format. If you write templates in the [Bicep](https://learn.microsoft.com/en-us/azure/azure-resource-manager/bicep/overview) language, you must use the [bicep CLI](https://learn.microsoft.com/en-us/azure/azure-resource-manager/bicep/bicep-cli) to convert your Bicep files into JSON before IaC scanning can analyze them.
+1. Terraform modules in a custom registry are not scanned for vulnerabilities. You can follow [issue 357004](https://gitlab.com/gitlab-org/gitlab/-/issues/357004) for the proposed feature.
## Customize rules
diff --git a/doc/user/application_security/sast/analyzers.md b/doc/user/application_security/sast/analyzers.md
index a238bec9d0291e..20db05af3f1fc5 100644
--- a/doc/user/application_security/sast/analyzers.md
+++ b/doc/user/application_security/sast/analyzers.md
@@ -41,13 +41,9 @@ SAST supports the following official analyzers:
- [`sobelow`](https://gitlab.com/gitlab-org/security-products/analyzers/sobelow) (Sobelow (Elixir Phoenix))
- [`spotbugs`](https://gitlab.com/gitlab-org/security-products/analyzers/spotbugs) (SpotBugs with the Find Sec Bugs plugin (Ant, Gradle and wrapper, Grails, Maven and wrapper, SBT))
-<html>
-<small>Footnotes:
- <ol>
- <li>These analyzers were <a href="https://gitlab.com/gitlab-org/gitlab/-/issues/431123">deprecated</a> in GitLab 16.9 and are planned for removal in 17.0. The <a href="https://gitlab.com/gitlab-org/security-products/analyzers/semgrep">Semgrep analyzer</a> is proposed as their replacement.</li>
- </ol>
-</small>
-</html>
+**Footnotes:**
+
+1. These analyzers were [deprecated](https://gitlab.com/gitlab-org/gitlab/-/issues/431123) in GitLab 16.9 and are planned for removal in 17.0. The [Semgrep analyzer](https://gitlab.com/gitlab-org/security-products/analyzers/semgrep) is proposed as their replacement.
SAST has used other analyzers in previous versions. These analyzers reached End of Support status and do not receive updates:
diff --git a/doc/user/gitlab_duo_chat.md b/doc/user/gitlab_duo_chat.md
index 7c611d69a88a9f..172b5622264776 100644
--- a/doc/user/gitlab_duo_chat.md
+++ b/doc/user/gitlab_duo_chat.md
@@ -31,13 +31,9 @@ Here are the examples of use cases:
| [Refactor code in the IDE](#refactor-code-in-the-ide) | I want to refactor this code. | VS Code and Web IDE <sup>1</sup> | GitLab.com, self-managed, and GitLab Dedicated |
| [Write tests in the IDE](#write-tests-in-the-ide) | I want to write a test for this code. | VS Code and Web IDE <sup>1</sup> | GitLab.com, self-managed, and GitLab Dedicated |
-<html>
-<small>Footnotes:
- <ol>
- <li>GitLab Duo Chat is not available in Web IDE on self-managed</li>
- </ol>
-</small>
-</html>
+**Footnotes:**
+
+1. GitLab Duo Chat is not available in the Web IDE on self-managed.
NOTE:
This is a Beta feature. We're continuously extending the capabilities and reliability of the responses.
diff --git a/doc/user/group/import/index.md b/doc/user/group/import/index.md
index dc235f6f4cd80a..47e239d10b697f 100644
--- a/doc/user/group/import/index.md
+++ b/doc/user/group/import/index.md
@@ -440,13 +440,9 @@ Project items that are migrated to the destination GitLab instance include:
| Uploads | [GitLab 14.5](https://gitlab.com/gitlab-org/gitlab/-/issues/339401) |
| Wikis | [GitLab 14.6](https://gitlab.com/gitlab-org/gitlab/-/issues/345923) |
-<html>
-<small>Footnotes:
- <ol>
- <li>Imported branches respect the <a href="https://docs.gitlab.com/ee/user/project/protected_branches.html">default branch protection settings</a> of the destination group, which can cause an unprotected branch to be imported as protected.</li>
- </ol>
-</small>
-</html>
+**Footnotes:**
+
+1. Imported branches respect the [default branch protection settings](https://docs.gitlab.com/ee/user/project/protected_branches.html) of the destination group, which can cause an unprotected branch to be imported as protected.
### Issue-related items
diff --git a/doc/user/project/members/index.md b/doc/user/project/members/index.md
index 4d2348ad814be2..c654c1879c2c98 100644
--- a/doc/user/project/members/index.md
+++ b/doc/user/project/members/index.md
@@ -387,13 +387,9 @@ The following table lists the membership and visibility rights of group members.
| View labels of parent groups | **{check-circle}** Yes | **{check-circle}** Yes | **{check-circle}** Yes | **{check-circle}** Yes |
| View milestones of parent groups | **{check-circle}** Yes | **{check-circle}** Yes | **{check-circle}** Yes | **{check-circle}** Yes |
-<html>
-<small>Footnotes:
- <ol>
- <li>Users can view only issues of projects they have access to.</li>
- </ol>
-</small>
-</html>
+**Footnotes:**
+
+1. Users can view only issues of projects they have access to.
In the following example, `User` is a:
--
GitLab
From eb3e4593708ad52dcf197add4a60fd34305a4055 Mon Sep 17 00:00:00 2001
From: Ashraf Khamis <akhamis@gitlab.com>
Date: Mon, 25 Mar 2024 10:36:51 +0000
Subject: [PATCH 2/4] Apply 14 suggestion(s) to 6 file(s)
---
doc/api/groups.md | 2 +-
.../dependency_list/index.md | 9 ++-------
.../application_security/iac_scanning/index.md | 18 ++++++++++++------
.../application_security/sast/analyzers.md | 12 +++++++-----
doc/user/group/import/index.md | 2 +-
doc/user/project/members/index.md | 8 ++++----
6 files changed, 27 insertions(+), 24 deletions(-)
diff --git a/doc/api/groups.md b/doc/api/groups.md
index bcfbb5b2f1d2d1..1541934f449112 100644
--- a/doc/api/groups.md
+++ b/doc/api/groups.md
@@ -333,7 +333,7 @@ Parameters:
**Footnotes:**
-1. Order by similarity: Orders the results by a similarity score calculated from the provided `search` URL parameter. When using `order_by=similarity`, the `sort` parameter is ignored. When the `search` parameter is not provided, the API returns the projects ordered by `name`.
+1. Orders the results by a similarity score calculated from the `search` URL parameter. When you use `order_by=similarity`, the `sort` parameter is ignored. When the `search` parameter is not provided, the API returns the projects ordered by `name`.
Example response:
diff --git a/doc/user/application_security/dependency_list/index.md b/doc/user/application_security/dependency_list/index.md
index 832f69c9b65afc..3a49690e520f0f 100644
--- a/doc/user/application_security/dependency_list/index.md
+++ b/doc/user/application_security/dependency_list/index.md
@@ -51,13 +51,8 @@ Details of each dependency are listed, sorted by decreasing severity of vulnerab
| Component | The dependency's name and version. |
| Packager | The packager used to install the dependency. |
| Location | For system dependencies, this lists the image that was scanned. For application dependencies, this shows a link to the packager-specific lock file in your project that declared the dependency. It also shows the [dependency path](#dependency-paths) to a top-level dependency, if any, and if supported. |
-| License<sup>1</sup> | Links to dependency's software licenses. A warning badge that includes the number of vulnerabilities detected in the dependency. |
-| Projects<sup>2</sup> | Links to the project with the dependency. If multiple projects have the same dependency, the total number of these projects is shown. To go to a project with this dependency, select the **Projects** number, then search for and select its name. The project search feature is supported only on groups that have up to 600 occurrences in their group hierarchy. |
-
-**Footnotes:**
-
-1. Project-level only
-1. Group-level only
+| License (for projects only) | Links to dependency's software licenses. A warning badge that includes the number of vulnerabilities detected in the dependency. |
+| Projects (for groups only) | Links to the project with the dependency. If multiple projects have the same dependency, the total number of these projects is shown. To go to a project with this dependency, select the **Projects** number, then search for and select its name. The project search feature is supported only on groups that have up to 600 occurrences in their group hierarchy. |
diff --git a/doc/user/application_security/iac_scanning/index.md b/doc/user/application_security/iac_scanning/index.md
index 529d648f64f562..11e0b0c22cbff9 100644
--- a/doc/user/application_security/iac_scanning/index.md
+++ b/doc/user/application_security/iac_scanning/index.md
@@ -66,17 +66,23 @@ Supported configuration formats:
- Ansible
- AWS CloudFormation
-- Azure Resource Manager <sup>1</sup>
+- Azure Resource Manager
+
+ NOTE:
+ IaC scanning can analyze Azure Resource Manager templates in JSON format.
+ If you write templates in [Bicep](https://learn.microsoft.com/en-us/azure/azure-resource-manager/bicep/overview),
+ you must use the [Bicep CLI](https://learn.microsoft.com/en-us/azure/azure-resource-manager/bicep/bicep-cli) to
+ convert your Bicep files into JSON before IaC scanning can analyze them.
+
- Dockerfile
- Google Deployment Manager
- Kubernetes
- OpenAPI
-- Terraform <sup>2</sup>
-
-**Footnotes:**
+- Terraform
-1. IaC Scanning can analyze Azure Resource Manager templates in JSON format. If you write templates in the [Bicep](https://learn.microsoft.com/en-us/azure/azure-resource-manager/bicep/overview) language, you must use the [bicep CLI](https://learn.microsoft.com/en-us/azure/azure-resource-manager/bicep/bicep-cli) to convert your Bicep files into JSON before IaC scanning can analyze them.
-1. Terraform modules in a custom registry are not scanned for vulnerabilities. You can follow [issue 357004](https://gitlab.com/gitlab-org/gitlab/-/issues/357004) for the proposed feature.
+ NOTE:
+ Terraform modules in a custom registry are not scanned for vulnerabilities.
+ For more information about the proposed feature, see [issue 357004](https://gitlab.com/gitlab-org/gitlab/-/issues/357004).
## Customize rules
diff --git a/doc/user/application_security/sast/analyzers.md b/doc/user/application_security/sast/analyzers.md
index 20db05af3f1fc5..a5a56305746b64 100644
--- a/doc/user/application_security/sast/analyzers.md
+++ b/doc/user/application_security/sast/analyzers.md
@@ -35,16 +35,18 @@ SAST supports the following official analyzers:
- [`kubesec`](https://gitlab.com/gitlab-org/security-products/analyzers/kubesec) (Kubesec)
- [`mobsf`](https://gitlab.com/gitlab-org/security-products/analyzers/mobsf) (MobSF) (**Status:** Beta)
- [`nodejs-scan`](https://gitlab.com/gitlab-org/security-products/analyzers/nodejs-scan) (NodeJsScan) <sup>1</sup>
-- [`phpcs-security-audit`](https://gitlab.com/gitlab-org/security-products/analyzers/phpcs-security-audit) (PHP CS security-audit) <sup>1</sup>
+- [`phpcs-security-audit`](https://gitlab.com/gitlab-org/security-products/analyzers/phpcs-security-audit) (PHP CS security-audit)
+
+ NOTE:
+ These analyzers were [deprecated](https://gitlab.com/gitlab-org/gitlab/-/issues/431123) in GitLab 16.9
+ and are planned for removal in 17.0.
+ The [Semgrep analyzer](https://gitlab.com/gitlab-org/security-products/analyzers/semgrep) is proposed as their replacement.
+
- [`pmd-apex`](https://gitlab.com/gitlab-org/security-products/analyzers/pmd-apex) (PMD (Apex only))
- [`semgrep`](https://gitlab.com/gitlab-org/security-products/analyzers/semgrep) (Semgrep)
- [`sobelow`](https://gitlab.com/gitlab-org/security-products/analyzers/sobelow) (Sobelow (Elixir Phoenix))
- [`spotbugs`](https://gitlab.com/gitlab-org/security-products/analyzers/spotbugs) (SpotBugs with the Find Sec Bugs plugin (Ant, Gradle and wrapper, Grails, Maven and wrapper, SBT))
-**Footnotes:**
-
-1. These analyzers were [deprecated](https://gitlab.com/gitlab-org/gitlab/-/issues/431123) in GitLab 16.9 and are planned for removal in 17.0. The [Semgrep analyzer](https://gitlab.com/gitlab-org/security-products/analyzers/semgrep) is proposed as their replacement.
-
SAST has used other analyzers in previous versions. These analyzers reached End of Support status and do not receive updates:
- [`bandit`](https://gitlab.com/gitlab-org/security-products/analyzers/bandit) (Bandit); [End of Support](https://gitlab.com/gitlab-org/gitlab/-/issues/352554) in GitLab 15.4. Replaced by the `semgrep` analyzer with GitLab-managed rules.
diff --git a/doc/user/group/import/index.md b/doc/user/group/import/index.md
index 47e239d10b697f..e65eb3615a6ce5 100644
--- a/doc/user/group/import/index.md
+++ b/doc/user/group/import/index.md
@@ -442,7 +442,7 @@ Project items that are migrated to the destination GitLab instance include:
**Footnotes:**
-1. Imported branches respect the [default branch protection settings](https://docs.gitlab.com/ee/user/project/protected_branches.html) of the destination group, which can cause an unprotected branch to be imported as protected.
+1. Imported branches respect the [default branch protection settings](../../project/protected_branches.html) of the destination group, which could cause an unprotected branch to be imported as protected.
### Issue-related items
diff --git a/doc/user/project/members/index.md b/doc/user/project/members/index.md
index c654c1879c2c98..92bb800d7a34a7 100644
--- a/doc/user/project/members/index.md
+++ b/doc/user/project/members/index.md
@@ -378,6 +378,10 @@ The following table lists the membership and visibility rights of project member
| Be imported into other projects | **{check-circle}** Yes | **{dotted-circle}** No | **{dotted-circle}** No | **{dotted-circle}** No |
| Share the project with other members | **{check-circle}** Yes | **{check-circle}** Yes | **{check-circle}** Yes | **{check-circle}** Yes |
+**Footnotes:**
+
+1. Users can view only issues of projects they have access to.
+
The following table lists the membership and visibility rights of group members.
| Action | Direct group member | Inherited group member | Direct shared group member | Inherited shared group member |
@@ -387,10 +391,6 @@ The following table lists the membership and visibility rights of group members.
| View labels of parent groups | **{check-circle}** Yes | **{check-circle}** Yes | **{check-circle}** Yes | **{check-circle}** Yes |
| View milestones of parent groups | **{check-circle}** Yes | **{check-circle}** Yes | **{check-circle}** Yes | **{check-circle}** Yes |
-**Footnotes:**
-
-1. Users can view only issues of projects they have access to.
-
In the following example, `User` is a:
- Direct member of `subgroup`.
--
GitLab
From 391a1f95b5a8e6887c07a8e190ea33f0567537ea Mon Sep 17 00:00:00 2001
From: Ashraf Khamis <akhamis@gitlab.com>
Date: Mon, 25 Mar 2024 10:47:00 +0000
Subject: [PATCH 3/4] Apply 2 suggestion(s) to 2 file(s)
---
doc/api/groups.md | 4 +++-
doc/user/group/import/index.md | 3 ++-
2 files changed, 5 insertions(+), 2 deletions(-)
diff --git a/doc/api/groups.md b/doc/api/groups.md
index 1541934f449112..c5e4344f8c423d 100644
--- a/doc/api/groups.md
+++ b/doc/api/groups.md
@@ -333,7 +333,9 @@ Parameters:
**Footnotes:**
-1. Orders the results by a similarity score calculated from the `search` URL parameter. When you use `order_by=similarity`, the `sort` parameter is ignored. When the `search` parameter is not provided, the API returns the projects ordered by `name`.
+1. Orders the results by a similarity score calculated from the `search` URL parameter.
+ When you use `order_by=similarity`, the `sort` parameter is ignored.
+ When the `search` parameter is not provided, the API returns the projects ordered by `name`.
Example response:
diff --git a/doc/user/group/import/index.md b/doc/user/group/import/index.md
index e65eb3615a6ce5..2fc10951ca4e84 100644
--- a/doc/user/group/import/index.md
+++ b/doc/user/group/import/index.md
@@ -442,7 +442,8 @@ Project items that are migrated to the destination GitLab instance include:
**Footnotes:**
-1. Imported branches respect the [default branch protection settings](../../project/protected_branches.html) of the destination group, which could cause an unprotected branch to be imported as protected.
+1. Imported branches respect the [default branch protection settings](../../project/protected_branches.md)
+ of the destination group, which could cause an unprotected branch to be imported as protected.
### Issue-related items
--
GitLab
From 286347aa0f7afefe05c0994c081418154be5067a Mon Sep 17 00:00:00 2001
From: Ashraf Khamis <akhamis@gitlab.com>
Date: Mon, 25 Mar 2024 21:09:36 +0000
Subject: [PATCH 4/4] Apply 1 suggestion(s) to 1 file(s)
---
.../application_security/sast/analyzers.md | 18 +++++++++---------
1 file changed, 9 insertions(+), 9 deletions(-)
diff --git a/doc/user/application_security/sast/analyzers.md b/doc/user/application_security/sast/analyzers.md
index a5a56305746b64..62eda38d98a3d9 100644
--- a/doc/user/application_security/sast/analyzers.md
+++ b/doc/user/application_security/sast/analyzers.md
@@ -30,23 +30,23 @@ For each scanner, an analyzer:
SAST supports the following official analyzers:
-- [`brakeman`](https://gitlab.com/gitlab-org/security-products/analyzers/brakeman) (Brakeman) <sup>1</sup>
-- [`flawfinder`](https://gitlab.com/gitlab-org/security-products/analyzers/flawfinder) (Flawfinder) <sup>1</sup>
+- [`brakeman`](https://gitlab.com/gitlab-org/security-products/analyzers/brakeman) (Brakeman)
+- [`flawfinder`](https://gitlab.com/gitlab-org/security-products/analyzers/flawfinder) (Flawfinder)
- [`kubesec`](https://gitlab.com/gitlab-org/security-products/analyzers/kubesec) (Kubesec)
- [`mobsf`](https://gitlab.com/gitlab-org/security-products/analyzers/mobsf) (MobSF) (**Status:** Beta)
-- [`nodejs-scan`](https://gitlab.com/gitlab-org/security-products/analyzers/nodejs-scan) (NodeJsScan) <sup>1</sup>
+- [`nodejs-scan`](https://gitlab.com/gitlab-org/security-products/analyzers/nodejs-scan) (NodeJsScan)
- [`phpcs-security-audit`](https://gitlab.com/gitlab-org/security-products/analyzers/phpcs-security-audit) (PHP CS security-audit)
-
- NOTE:
- These analyzers were [deprecated](https://gitlab.com/gitlab-org/gitlab/-/issues/431123) in GitLab 16.9
- and are planned for removal in 17.0.
- The [Semgrep analyzer](https://gitlab.com/gitlab-org/security-products/analyzers/semgrep) is proposed as their replacement.
-
- [`pmd-apex`](https://gitlab.com/gitlab-org/security-products/analyzers/pmd-apex) (PMD (Apex only))
- [`semgrep`](https://gitlab.com/gitlab-org/security-products/analyzers/semgrep) (Semgrep)
- [`sobelow`](https://gitlab.com/gitlab-org/security-products/analyzers/sobelow) (Sobelow (Elixir Phoenix))
- [`spotbugs`](https://gitlab.com/gitlab-org/security-products/analyzers/spotbugs) (SpotBugs with the Find Sec Bugs plugin (Ant, Gradle and wrapper, Grails, Maven and wrapper, SBT))
+NOTE:
+`brakeman`, `flawfinder`, `nodejs-scan`, and `phpcs-security-audit` were
+[deprecated](https://gitlab.com/gitlab-org/gitlab/-/issues/431123) in GitLab 16.9
+and are planned for removal in 17.0.
+The [Semgrep analyzer](https://gitlab.com/gitlab-org/security-products/analyzers/semgrep) is proposed as their replacement.
+
SAST has used other analyzers in previous versions. These analyzers reached End of Support status and do not receive updates:
- [`bandit`](https://gitlab.com/gitlab-org/security-products/analyzers/bandit) (Bandit); [End of Support](https://gitlab.com/gitlab-org/gitlab/-/issues/352554) in GitLab 15.4. Replaced by the `semgrep` analyzer with GitLab-managed rules.
--
GitLab