[promoted to epic] End-to-end QA of localized docs site by L10n team prior to launch
Goal
- Engineering team @laurenbarker @rasamhossain @jcole-ext to provide environment for such QA
- Localization program management and localization engineering team (cc @mjsibanez @muchikawa @emikimura-ext @rasamhossain @laurenbarker @jcole-ext @mpehkonen) to conduct comprehensive manual testing to ensure the localized docs site functions correctly before internal launch, after development work is done. Take inspiration from End-to-end QA (gitlab-org/technical-writing/docs-gitlab-com#164 - closed)
- Per Lauren's note: #162 (comment 2547064285), create issues for known bugs under the following epic: Pre-Launch: Japanese Docs QA - Bug Fixes (&125 - closed)
Tasks (Draft)
- Language selector
-
Language selector button is properly switching languages from english to japanese and vice versa -
When switching languages you get the EN or JA version of the page, without being redirected to the homepage or erroring out.
- Navigation
-
Left navigation expands, collapses, and otherwise works as expected. -
Right nav renders correctly, matching the sections on the page. -
Clicking on top left navigation bar takes to to JA docs homepage -
Page titles and section headers (H2, H3, etc) render as expected, including when special characters or formatting are included like backtick content. -
Page titles render in browser tabs -
Top nav version menu will display all GitLab versions but only the latest will show up translated. -
Top nav "What's new?" redirects you to the English https://about.gitlab.com/releases/categories/releases/ -
Top nav "Get free trial" appears translated and redirects you to https://gitlab.com/-/trials/new?amp%3Bglm_content=navigation-cta-docs&glm_source=docs.gitlab.com. That landing page will serve translated content based on your browser language.
- Disclaimer banners
-
Disclaimer AI message appears as a sticky banner in all the JA pages. JA disclaimer content is appropriate. -
"Contribute" disclaimer message
- Special content blocks:
-
Diagrams render as expected in English (Mermaid samples, plantUML samples) -
Codeblocks render as expected in English, with code coloring. -
SVGs display correctly in English in the JA pages, with appropriate size and spacing. -
Badges render correctly in all variations. -
Tables render correctly: -
Large tables do not stretch outside the view. -
Tables never overlap other content. -
Headers and other special characters (like <sup>and<br>) continue to work as expected in tables
-
-
NOTE:,WARNING:and other note blocks render as expected.
- "Contribute" left nav
-
"Contribute" section headers appear translated -
Users can go to the corresponding EN contribute section using the language selector -
Users can to to the corresponding EN contribute page clicking on the disclaimer link
- Deprecations and redirects
-
Deprecations page "Filter by removal version" feature works as expected: https://new.docs.gitlab.com/update/deprecations/ -
Redirect TBD
- Search TBD
-
only works in English. If a user types JA characters in search bar...
- Homepage
- [ ]
-
Footer links
- Footer links
- [ ]
- Help & Feedback component
-
Links to files from the "Help and Feedback" section (blue section at the bottom of every docs page) work. Especially the "Edit this page" link.
To clarify what this refers to?
History items render correctly in all variations:
Single items (unexpanded) Multiple items (expanded) Pages that use HTML for special formatting render as expected.
Known issues
- Search bar isn't working when searching in Japanese. Users get redirected to an EN error page and don't get any results.
- Content discrepancy between EN and JA. The JA page may not be at 100% sync with all the content that appears in English.
-
Homepage links: some links on the JA homepage (docs.gitlab.com/ja-jp) link out to an English page:
- Link to https://university.gitlab.com/learn/dashboard -only available in English
- Link to https://about.gitlab.com/support/ -only available in English
- Link to https://about.gitlab.com/community/contribute/ -only available in English
How to Report Bugs
For each bug found: Add a comment to this issue using the following template:
## Bug Report Template
#### [Bug Title]
1. **Bug**: [Clear description of what's broken]
2. **Where**: [URL(s) or location where bug occurs]
3. **Reproduce**: [Step-by-step instructions to recreate the issue]
4. **Browser/device**: [Link to https://whatismybrowser.com]
5. **Expected vs Actual**: [What should happen vs what actually happens]
6. **Severity**: [Critical/High/Medium/Low]
7. **Screenshot**: Visual evidence (if applicable)
Accessing the Review App
You can also go directly to the review app: https://docs.gitlab.com/review-mr-856/
Reported Bugs
Status: New → Assigned → In Progress → Fixed → Verified → Closed.
Edited by Maria Jose Salmeron Ibáñez