Merge branch 'docs-i18n-create-japanese-directory' into 'main'

Create Japanese documentation directory

See merge request gitlab-org/gitlab-runner!5513



Merged-by: Joe Burnett <jburnett@gitlab.com>
Approved-by: Marcel Amirault <mamirault@gitlab.com>
Reviewed-by: Marcel Amirault <mamirault@gitlab.com>
Co-authored-by: rasamhossain <rhossain@gitlab.com>

.gitlab/CODEOWNERS

@@ -10,3 +10,7 @@
 [Documentation]
 .markdownlint.yml @gitlab-com/runner-docs-maintainers
 /docs/ @gitlab-com/runner-docs-maintainers
+
+## Localization
+[Localization Team] @gitlab-com/localization/maintainers
+/docs-locale/**

.gitlab/ci/_rules.gitlab-ci.yml

@@ -21,6 +21,12 @@
   - "docs/**/*"
   - "scripts/lint-docs"
 
+.docs-i18n-patterns: &docs-patterns
+  - ".vale.ini"
+  - ".markdownlint.yml"
+  - "docs-locale/**/*"
+  - "scripts/lint-i18n-docs"
+
 ##############
 # Conditions #
 ##############

.gitlab/ci/qa.gitlab-ci.yml

@@ -104,6 +104,19 @@ docs:lint markdown:
     # Lint content and Markdown, and check links
     - make lint-docs VALE_MIN_ALERT_LEVEL=error
 
+docs:lint i18n markdown:
+  image: $DOCS_LINT_IMAGE
+  stage: qa
+  extends:
+    - .rules:merge_request_pipelines
+    - .no_cache_and_dependencies
+  needs: []
+  script:
+    # Makefiles in this project expect Go to be available
+    - apk add --quiet go
+    # Lint i18n content and Markdown
+    - make lint-i18n-docs VALE_MIN_ALERT_LEVEL=error
+
 docs:check feature flags:
   stage: qa
   extends:

Makefile

@@ -140,6 +140,10 @@ lint: $(GOLANGLINT)
 lint-docs:
 	@scripts/lint-docs
 
+.PHONY: lint-i18n-docs
+lint-i18n-docs:
+	@scripts/lint-i18n-docs
+
 .PHONY: format-ci-yaml
 format-ci-yaml:
 	prettier --write ".gitlab/ci/*.{yaml,yml}"

scripts/lint-i18n-docs

+#!/usr/bin/env bash
+
+set -o pipefail
+
+GIT_ROOT=$(cd "${BASH_SOURCE%/*}" && git rev-parse --show-toplevel)
+VALE_MIN_ALERT_LEVEL=${VALE_MIN_ALERT_LEVEL:-}
+ERROR_RESULTS=0
+
+echo "Lint prose"
+if command -v vale >/dev/null 2>&1; then
+    args=()
+    if [ -n "${VALE_MIN_ALERT_LEVEL}" ]; then
+        args+=("--minAlertLevel" "${VALE_MIN_ALERT_LEVEL}")
+    fi
+    vale --config "${GIT_ROOT}/.vale.ini" "${args[@]}" "${GIT_ROOT}/docs-locale" || ((ERROR_RESULTS++))
+else
+    echo "Vale is missing, please install it from https://vale.sh/docs/vale-cli/installation/"
+fi
+
+echo "Lint Markdown"
+if command -v markdownlint-cli2 >/dev/null 2>&1; then
+    markdownlint-cli2 'docs-locale/**/*.md' || ((ERROR_RESULTS++))
+else
+    echo "markdownlint-cli2 is missing, please install it from https://github.com/DavidAnson/markdownlint-cli2#install"
+fi
+
+if [ "${ERROR_RESULTS}" -ne 0 ]; then
+    echo "✖ ${ERROR_RESULTS} lint test(s) failed. Review the log carefully to see full listing."
+    exit 1
+else
+    echo "✔ Linting passed"
+    exit 0
+fi