Create Japanese documentation directory
What does this MR do and why?
Adding Japanese Documentation Structure
This MR adds a Japanese translated documentation file within a new /docs-locale/ja-jp/ directory structure, which will enable http://docs.gitlab.com/ja-jp/. We're starting with a single translated file to establish the directory structure, with more translations to follow.
Related Changes
This Runner MR has sister counterparts across GitLab projects that comprise our documentation site (GitLab, Operator, Charts, & Runner). A change to the docs site will follow to launch docs.gitlab.com/ja-jp/ that will use content from the /doc-locale/ja-jp/ directory.
Please see the SSOT issue for all information related to creating the /doc-locale/ directory structure to launch the Japanese documentation site.
Specific Changes of this MR
- Adds a single Japanese translated file to
/doc-locale/ja-jp/ - Updates
CODEOWNERSto designate @gitlab-com/localization/maintainers as owners of the new/doc-localedirectory - Creates i18n-specific CI jobs that mirror existing doc CI to lint content:
docs:lint i18n markdown - Create rules in the
.gitlab/ci/_rules.gitlab-ci.ymlfor.docs-i18n-patterns - Create script
scripts/lint-i18n-docs- currently this is duplicatingscripts/lint-docswith changes to the correct path - And related changes to the
MAKEFILE
References
- https://gitlab.com/gitlab-com/localization/docs-site-localization/-/issues/102 -> Primary issue with all context related to this work.
- gitlab-com/localization&104 (closed) -> primary epic with more context for all the relevant issues
- gitlab-com/localization/docs-site-localization#121 (closed) -> Engineering issue for this MR.
How to set up and validate locally
docs:lint i18n markdown: Test markdown linting for localized content
- Make edits to
/docs-locale/ja-jp/register/_index.mdthat will fail the markdown linter.- For example: remove spaces around lists, use inconsistent heading styles, or add improper indentation
- Run the linter locally to verify it catches the issues for the
/docs-localedirectorymarkdownlint-cli2 'docs-locale/**/*.md'
- Run Vale locally to see the validation errors:
make lint-i18n-docs VALE_MIN_ALERT_LEVEL=errorvale --config ".vale.ini" "docs-locale/ja-jp/register/_index.md"
MR acceptance checklist
Evaluate this MR against the MR acceptance checklist. It helps you analyze changes to reduce risks in quality, performance, reliability, security, and maintainability.