[Discussion / decision] Translation strategy for Contribute docs section
This issue aims to document the translation decision to exclude the "Contribute" section from translation in the left-side navigation of docs.gitlab.com/ja-jp. EN URL: https://docs.gitlab.com/development/
Context
The doc/development content serves as an internal engineering documentation primarily for GitLab engineers. This documentation contains code guidelines and contribution information, so it's not strictly product documentation. The Technical Writing team only ensures linting compliance for this section but doesn't manage the content.
At the same time, the Technical Writing team is in discussions with the Contributor Success team to explore the option of relocating this content to a more appropriate place.
Localization Rationale
While it feels wrong not to translate this section, all the contributions made to GitLab's code must be in English. All the reviews and processes at GitLab are in English for our engineering teams, and public contribution follows the same processes.
Now, it's also worth considering that having English content in the JA URL would negatively impact our JA SEO, so the best step forward here is to hide this section completely in the JA page and remove it from the translation scope on the content prioritization spreadsheet.
Questions
- Is it correct to assume that we can add the
doc/developmentfolder to the ignore paths on theargo_translation.ymlconfig file? That will not send any of the files under the folder be sent for translation. - What modifications are needed for the
navigation.ymlfile to:- Hide the "Contribute" section from the left-side menu in the Japanese verion
- Prevent users from encountering 404 errors when clicking these sections
- Maintain our practice of sending the latest navigation.yml for translation
- Simultaneously exclude sections we've decided not to translate
