Skip to content

G
gitlab-ce
Commit 7f3f36b7 authored by Amy Qualls's avatar Amy Qualls
Browse files
Options

Create test for internal anchors in uppercase 

Links to anchors (subheadings) in GitLab documentation should have
anchor fragments (everything after the #) in lower-case.
parent f0a70e7e
Hide whitespace changes
Inline Side-by-side
Showing with 41 additions and 28 deletions
doc/.vale/gitlab/InternalLinkCase.yml 0 → 100644
View file @ 7f3f36b7
---
# Error: gitlab.InternalLinkCase
#
# Checks that anchor fragments on internal links are in lower-case.
#
# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles
extends: existence
message: 'Links to subheadings in GitLab docs must be in lower-case: "%s"'
link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#links-to-internal-documentation
level: error
scope: raw
raw:
- '[^\`]\[[^\[\]]+\]\((https?:){0}[\w\/\.]*?#[^\s]*?[A-Z][^\) ]*\)[^\`]'
doc/administration/object_storage.md
View file @ 7f3f36b7
...@@ -543,7 +543,7 @@ supported by consolidated configuration form, refer to the following guides: ...@@ -543,7 +543,7 @@ supported by consolidated configuration form, refer to the following guides:
|Object storage type|Supported by consolidated configuration?| |Object storage type|Supported by consolidated configuration?|
|-------------------|----------------------------------------| |-------------------|----------------------------------------|
| [Backups](../raketasks/backup_restore.md#uploading-backups-to-a-remote-cloud-storage)|No| | [Backups](../raketasks/backup_restore.md#uploading-backups-to-a-remote-cloud-storage) | No |
| [Job artifacts](job_artifacts.md#using-object-storage) including archived job logs | Yes | | [Job artifacts](job_artifacts.md#using-object-storage) including archived job logs | Yes |
| [LFS objects](lfs/index.md#storing-lfs-objects-in-remote-object-storage) | Yes | | [LFS objects](lfs/index.md#storing-lfs-objects-in-remote-object-storage) | Yes |
| [Uploads](uploads.md#using-object-storage) | Yes | | [Uploads](uploads.md#using-object-storage) | Yes |
......
doc/administration/reference_architectures/10k_users.md
View file @ 7f3f36b7
...@@ -2066,7 +2066,7 @@ on what features you intend to use: ...@@ -2066,7 +2066,7 @@ on what features you intend to use:
|Object storage type|Supported by consolidated configuration?| |Object storage type|Supported by consolidated configuration?|
|-------------------|----------------------------------------| |-------------------|----------------------------------------|
| [Backups](../../raketasks/backup_restore.md#uploading-backups-to-a-remote-cloud-storage)|No| | [Backups](../../raketasks/backup_restore.md#uploading-backups-to-a-remote-cloud-storage) | No |
| [Job artifacts](../job_artifacts.md#using-object-storage) including archived job logs | Yes | | [Job artifacts](../job_artifacts.md#using-object-storage) including archived job logs | Yes |
| [LFS objects](../lfs/index.md#storing-lfs-objects-in-remote-object-storage) | Yes | | [LFS objects](../lfs/index.md#storing-lfs-objects-in-remote-object-storage) | Yes |
| [Uploads](../uploads.md#using-object-storage) | Yes | | [Uploads](../uploads.md#using-object-storage) | Yes |
......
doc/administration/reference_architectures/25k_users.md
View file @ 7f3f36b7
...@@ -2066,7 +2066,7 @@ on what features you intend to use: ...@@ -2066,7 +2066,7 @@ on what features you intend to use:
|Object storage type|Supported by consolidated configuration?| |Object storage type|Supported by consolidated configuration?|
|-------------------|----------------------------------------| |-------------------|----------------------------------------|
| [Backups](../../raketasks/backup_restore.md#uploading-backups-to-a-remote-cloud-storage)|No| | [Backups](../../raketasks/backup_restore.md#uploading-backups-to-a-remote-cloud-storage) | No |
| [Job artifacts](../job_artifacts.md#using-object-storage) including archived job logs | Yes | | [Job artifacts](../job_artifacts.md#using-object-storage) including archived job logs | Yes |
| [LFS objects](../lfs/index.md#storing-lfs-objects-in-remote-object-storage) | Yes | | [LFS objects](../lfs/index.md#storing-lfs-objects-in-remote-object-storage) | Yes |
| [Uploads](../uploads.md#using-object-storage) | Yes | | [Uploads](../uploads.md#using-object-storage) | Yes |
......
doc/administration/reference_architectures/2k_users.md
View file @ 7f3f36b7
...@@ -898,7 +898,7 @@ on what features you intend to use: ...@@ -898,7 +898,7 @@ on what features you intend to use:
|Object storage type|Supported by consolidated configuration?| |Object storage type|Supported by consolidated configuration?|
|-------------------|----------------------------------------| |-------------------|----------------------------------------|
| [Backups](../../raketasks/backup_restore.md#uploading-backups-to-a-remote-cloud-storage)|No| | [Backups](../../raketasks/backup_restore.md#uploading-backups-to-a-remote-cloud-storage) | No |
| [Job artifacts](../job_artifacts.md#using-object-storage) including archived job logs | Yes | | [Job artifacts](../job_artifacts.md#using-object-storage) including archived job logs | Yes |
| [LFS objects](../lfs/index.md#storing-lfs-objects-in-remote-object-storage) | Yes | | [LFS objects](../lfs/index.md#storing-lfs-objects-in-remote-object-storage) | Yes |
| [Uploads](../uploads.md#using-object-storage) | Yes | | [Uploads](../uploads.md#using-object-storage) | Yes |
......
doc/administration/reference_architectures/3k_users.md
View file @ 7f3f36b7
...@@ -1782,7 +1782,7 @@ on what features you intend to use: ...@@ -1782,7 +1782,7 @@ on what features you intend to use:
|Object storage type|Supported by consolidated configuration?| |Object storage type|Supported by consolidated configuration?|
|-------------------|----------------------------------------| |-------------------|----------------------------------------|
| [Backups](../../raketasks/backup_restore.md#uploading-backups-to-a-remote-cloud-storage)|No| | [Backups](../../raketasks/backup_restore.md#uploading-backups-to-a-remote-cloud-storage) | No |
| [Job artifacts](../job_artifacts.md#using-object-storage) including archived job logs | Yes | | [Job artifacts](../job_artifacts.md#using-object-storage) including archived job logs | Yes |
| [LFS objects](../lfs/index.md#storing-lfs-objects-in-remote-object-storage) | Yes | | [LFS objects](../lfs/index.md#storing-lfs-objects-in-remote-object-storage) | Yes |
| [Uploads](../uploads.md#using-object-storage) | Yes | | [Uploads](../uploads.md#using-object-storage) | Yes |
......
doc/administration/reference_architectures/50k_users.md
View file @ 7f3f36b7
...@@ -2066,7 +2066,7 @@ on what features you intend to use: ...@@ -2066,7 +2066,7 @@ on what features you intend to use:
|Object storage type|Supported by consolidated configuration?| |Object storage type|Supported by consolidated configuration?|
|-------------------|----------------------------------------| |-------------------|----------------------------------------|
| [Backups](../../raketasks/backup_restore.md#uploading-backups-to-a-remote-cloud-storage)|No| | [Backups](../../raketasks/backup_restore.md#uploading-backups-to-a-remote-cloud-storage) | No |
| [Job artifacts](../job_artifacts.md#using-object-storage) including archived job logs | Yes | | [Job artifacts](../job_artifacts.md#using-object-storage) including archived job logs | Yes |
| [LFS objects](../lfs/index.md#storing-lfs-objects-in-remote-object-storage) | Yes | | [LFS objects](../lfs/index.md#storing-lfs-objects-in-remote-object-storage) | Yes |
| [Uploads](../uploads.md#using-object-storage) | Yes | | [Uploads](../uploads.md#using-object-storage) | Yes |
......
doc/administration/reference_architectures/5k_users.md
View file @ 7f3f36b7
...@@ -1782,7 +1782,7 @@ on what features you intend to use: ...@@ -1782,7 +1782,7 @@ on what features you intend to use:
|Object storage type|Supported by consolidated configuration?| |Object storage type|Supported by consolidated configuration?|
|-------------------|----------------------------------------| |-------------------|----------------------------------------|
| [Backups](../../raketasks/backup_restore.md#uploading-backups-to-a-remote-cloud-storage)|No| | [Backups](../../raketasks/backup_restore.md#uploading-backups-to-a-remote-cloud-storage) | No |
| [Job artifacts](../job_artifacts.md#using-object-storage) including archived job logs | Yes | | [Job artifacts](../job_artifacts.md#using-object-storage) including archived job logs | Yes |
| [LFS objects](../lfs/index.md#storing-lfs-objects-in-remote-object-storage) | Yes | | [LFS objects](../lfs/index.md#storing-lfs-objects-in-remote-object-storage) | Yes |
| [Uploads](../uploads.md#using-object-storage) | Yes | | [Uploads](../uploads.md#using-object-storage) | Yes |
......
doc/api/project_templates.md
View file @ 7f3f36b7
...@@ -21,8 +21,8 @@ It deprecates these endpoints, which will be removed for API version 5. ...@@ -21,8 +21,8 @@ It deprecates these endpoints, which will be removed for API version 5.
In addition to templates common to the entire instance, project-specific In addition to templates common to the entire instance, project-specific
templates are also available from this API endpoint. templates are also available from this API endpoint.
Support for [Group-level file templates](../user/group/index.md#group-file-templates) Support for [Group-level file templates](../user/group/index.md#group-file-templates) **(PREMIUM)**
**(PREMIUM)** was [added](https://gitlab.com/gitlab-org/gitlab/-/issues/5987) was [added](https://gitlab.com/gitlab-org/gitlab/-/issues/5987)
in GitLab 11.5 in GitLab 11.5
## Get all templates of a particular type ## Get all templates of a particular type
......
doc/user/application_security/api_fuzzing/index.md
View file @ 7f3f36b7
...@@ -488,24 +488,24 @@ increases as the numbers go up. To use a configuration file, add it to your repo ...@@ -488,24 +488,24 @@ increases as the numbers go up. To use a configuration file, add it to your repo
| Environment variable | Description | | Environment variable | Description |
|-----------------------------|--------------------| |-----------------------------|--------------------|
| `FUZZAPI_VERSION` |Specify API Fuzzing container version. Defaults to `latest`. | | `FUZZAPI_VERSION` | Specify API Fuzzing container version. Defaults to `latest`. |
| `FUZZAPI_TARGET_URL` |Base URL of API testing target. | | `FUZZAPI_TARGET_URL` | Base URL of API testing target. |
|[`FUZZAPI_CONFIG`](#configuration-files)|API Fuzzing configuration file. Defaults to `.gitlab-apifuzzer.yml`. | |[`FUZZAPI_CONFIG`](#configuration-files) | API Fuzzing configuration file. Defaults to `.gitlab-apifuzzer.yml`. |
|[`FUZZAPI_PROFILE`](#configuration-files)|Configuration profile to use during testing. Defaults to `Quick`. | |[`FUZZAPI_PROFILE`](#configuration-files) | Configuration profile to use during testing. Defaults to `Quick`. |
| `FUZZAPI_REPORT` |Scan report filename. Defaults to `gl-api_fuzzing-report.xml`. | | `FUZZAPI_REPORT` | Scan report filename. Defaults to `gl-api_fuzzing-report.xml`. |
|[`FUZZAPI_OPENAPI`](#openapi-specification)|OpenAPI specification file or URL. | |[`FUZZAPI_OPENAPI`](#openapi-specification) | OpenAPI specification file or URL. |
|[`FUZZAPI_HAR`](#http-archive-har)|HTTP Archive (HAR) file. | |[`FUZZAPI_HAR`](#http-archive-har) | HTTP Archive (HAR) file. |
|[`FUZZAPI_POSTMAN_COLLECTION`](#postman-collection)|Postman Collection file. | |[`FUZZAPI_POSTMAN_COLLECTION`](#postman-collection) | Postman Collection file. |
|[`FUZZAPI_OVERRIDES_FILE`](#overrides) |Path to a JSON file containing overrides. | |[`FUZZAPI_OVERRIDES_FILE`](#overrides) | Path to a JSON file containing overrides. |
|[`FUZZAPI_OVERRIDES_ENV`](#overrides) |JSON string containing headers to override. | |[`FUZZAPI_OVERRIDES_ENV`](#overrides) | JSON string containing headers to override. |
|[`FUZZAPI_OVERRIDES_CMD`](#overrides) |Overrides command. | |[`FUZZAPI_OVERRIDES_CMD`](#overrides) | Overrides command. |
|[`FUZZAPI_OVERRIDES_INTERVAL`](#overrides) |How often to run overrides command in seconds. Defaults to `0` (once). | |[`FUZZAPI_OVERRIDES_INTERVAL`](#overrides) | How often to run overrides command in seconds. Defaults to `0` (once). |
|[`FUZZAPI_HTTP_USERNAME`](#http-basic-authentication) |Username for HTTP authentication. | |[`FUZZAPI_HTTP_USERNAME`](#http-basic-authentication) | Username for HTTP authentication. |
|[`FUZZAPI_HTTP_PASSWORD`](#http-basic-authentication) |Password for HTTP authentication. | |[`FUZZAPI_HTTP_PASSWORD`](#http-basic-authentication) | Password for HTTP authentication. |
<!--|[`FUZZAPI_D_TARGET_IMAGE`](#target-container) |API target docker image | <!--|[`FUZZAPI_D_TARGET_IMAGE`](#target-container) |API target docker image |
|[`FUZZAPI_D_TARGET_ENV`](#target-container) |Docker environment options | |[`FUZZAPI_D_TARGET_ENV`](#target-container) |Docker environment options |
|[`FUZZAPI_D_TARGET_VOLUME`](#target-container)|Docker volume options | |[`FUZZAPI_D_TARGET_VOLUME`](#target-container) | Docker volume options |
|[`FUZZAPI_D_TARGET_PORTS`](#target-container) |Docker port options | |[`FUZZAPI_D_TARGET_PORTS`](#target-container) |Docker port options |
| `FUZZAPI_D_WORKER_IMAGE` |Custom worker docker image | | `FUZZAPI_D_WORKER_IMAGE` |Custom worker docker image |
| `FUZZAPI_D_WORKER_ENV` |Custom worker docker environment options | | `FUZZAPI_D_WORKER_ENV` |Custom worker docker environment options |
......
doc/user/markdown.md
View file @ 7f3f36b7
...@@ -441,8 +441,8 @@ GFM recognizes the following: ...@@ -441,8 +441,8 @@ GFM recognizes the following:
| multi-word milestone by name | `%"release candidate"` | `namespace/project%"release candidate"` | `project%"release candidate"` | | multi-word milestone by name | `%"release candidate"` | `namespace/project%"release candidate"` | `project%"release candidate"` |
| specific commit | `9ba12248` | `namespace/project@9ba12248` | `project@9ba12248` | | specific commit | `9ba12248` | `namespace/project@9ba12248` | `project@9ba12248` |
| commit range comparison | `9ba12248...b19a04f5` | `namespace/project@9ba12248...b19a04f5` | `project@9ba12248...b19a04f5` | | commit range comparison | `9ba12248...b19a04f5` | `namespace/project@9ba12248...b19a04f5` | `project@9ba12248...b19a04f5` |
| repository file references | `[README](doc/README)` | | | | repository file references | `[README](doc/README.md)` | | |
| repository file line references | `[README](doc/README#L13)` | | | | repository file line references | `[README](doc/README.md#L13)` | | |
| [alert](../operations/incident_management/alerts.md) | `^alert#123` | `namespace/project^alert#123` | `project^alert#123` | | [alert](../operations/incident_management/alerts.md) | `^alert#123` | `namespace/project^alert#123` | `project^alert#123` |
For example, referencing an issue by using `#123` will format the output as a link For example, referencing an issue by using `#123` will format the output as a link
......
doc/user/project/issues/index.md
View file @ 7f3f36b7
...@@ -93,7 +93,7 @@ must be set. ...@@ -93,7 +93,7 @@ must be set.
While you can view and manage the full details of an issue on the [issue page](#issue-page), While you can view and manage the full details of an issue on the [issue page](#issue-page),
you can also work with multiple issues at a time using the [Issues List](#issues-list), you can also work with multiple issues at a time using the [Issues List](#issues-list),
[Issue Boards](#issue-boards), Issue references, and [Epics](#epics)**(PREMIUM)**. [Issue Boards](#issue-boards), Issue references, and [Epics](#epics). **(PREMIUM)**
Key actions for issues include: Key actions for issues include:
......
doc/user/project/issues/issue_data_and_actions.md
View file @ 7f3f36b7
...@@ -186,7 +186,7 @@ The plain text title and description of the issue fill the top center of the iss ...@@ -186,7 +186,7 @@ The plain text title and description of the issue fill the top center of the iss
The description fully supports [GitLab Flavored Markdown](../../markdown.md#gitlab-flavored-markdown-gfm), The description fully supports [GitLab Flavored Markdown](../../markdown.md#gitlab-flavored-markdown-gfm),
allowing many formatting options. allowing many formatting options.
> [In GitLab 12.6](https://gitlab.com/gitlab-org/gitlab/-/issues/10103) and later, changes to an issue's description are listed in the [issue history](#issue-history).**(STARTER)** > [In GitLab 12.6](https://gitlab.com/gitlab-org/gitlab/-/issues/10103) and later, changes to an issue's description are listed in the [issue history](#issue-history). **(STARTER)**
### Mentions ### Mentions
......
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
GitLab Nexedi Edition | About GitLab | About Nexedi | 沪ICP备2021021310号-2 | 沪ICP备2021021310号-7