diff options
| author | GitLab Bot <gitlab-bot@gitlab.com> | 2022-12-26 09:08:19 +0300 |
|---|---|---|
| committer | GitLab Bot <gitlab-bot@gitlab.com> | 2022-12-26 09:08:19 +0300 |
| commit | c4b7a3e5c1209bc9931b6ce035a13046db3c2542 (patch) | |
| tree | 2aa1966a0efc9f5b6d731befe646094ef9452fa0 | |
| parent | 8e0d6e9671ba9013fc29a16c31dee4757eda9387 (diff) | |
Add latest changes from gitlab-org/gitlab@master
| -rw-r--r-- | doc/.vale/gitlab/TabsLinks.yml | 13 | ||||
| -rw-r--r-- | doc/development/documentation/styleguide/index.md | 2 | ||||
| -rw-r--r-- | doc/development/gitlab_flavored_markdown/specification_guide/index.md | 6 |
3 files changed, 21 insertions, 0 deletions
diff --git a/doc/.vale/gitlab/TabsLinks.yml b/doc/.vale/gitlab/TabsLinks.yml new file mode 100644 index 00000000000..97f75046fca --- /dev/null +++ b/doc/.vale/gitlab/TabsLinks.yml @@ -0,0 +1,13 @@ +--- +# Error: gitlab.TabsLinks +# +# Checks for the presence of links to individual GitLab UI tabs. +# +# For a list of all options, see https://vale.sh/docs/topics/styles/ +extends: existence +message: "Do not include tabs query parameters in links." +link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#tabs +level: error +scope: raw +raw: + - '\[[^\]]+\]\(.*?\.md\?tab=.*?\)' diff --git a/doc/development/documentation/styleguide/index.md b/doc/development/documentation/styleguide/index.md index 3135f59e3ad..fe2554feeb7 100644 --- a/doc/development/documentation/styleguide/index.md +++ b/doc/development/documentation/styleguide/index.md @@ -1446,6 +1446,8 @@ For example: [configuration edits guide](#configuration-documentation-for-different-installation-methods)) - `15.1 and earlier`, `15.2 and later` +Until we implement automated testing for broken links to tabs ([Issue 1355](https://gitlab.com/gitlab-org/gitlab-docs/-/issues/1355)), do not link directly to a single tab, even though they do have unique URL parameters. + See [Pajamas](https://design.gitlab.com/components/tabs/#guidelines) for more details on tabs. diff --git a/doc/development/gitlab_flavored_markdown/specification_guide/index.md b/doc/development/gitlab_flavored_markdown/specification_guide/index.md index 2b3f78aa65e..828a929cb51 100644 --- a/doc/development/gitlab_flavored_markdown/specification_guide/index.md +++ b/doc/development/gitlab_flavored_markdown/specification_guide/index.md @@ -114,6 +114,12 @@ it does not have a static, hardcoded, manually updated `spec.txt`. Instead, the GLFM `spec.txt` is automatically generated based on other input files. This process is explained in detail in the [Implementation](#implementation) sections below. +NOTE: +As of December 2022, the HTML version of the [GitHub Flavored Markdown (GFM) specification](https://github.github.com/gfm/) +is outdated, and does not match the [specification's `spec.txt`](https://github.com/github/cmark-gfm/blob/master/test/spec.txt). +An issue has been [filed in the `cmark-gfm` project](https://github.com/github/cmark-gfm/issues/288) +to report this. + #### Official specifications vs internal extensions Within GFM and GLFM respectively, both GitHub and GitLab have two "sets" of Markdown they support: |