Refactor and Optimize GitHub Docs Localization YAML#39402
Refactor and Optimize GitHub Docs Localization YAML#39402NirajDN wants to merge 3 commits intogithub:mainfrom
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR refactors the GitHub Docs localization YAML file (data/ui.yml) to improve maintainability and readability. The changes focus on enhancing the structural organization of the configuration without modifying any user-facing content or functionality.
- Enhanced formatting and organization with consistent grouping of related sections
- Added blank line separators between major configuration sections for improved readability
- Simplified the release candidate notification structure by removing unnecessary comment and consolidating the configuration
data/ui.yml
Outdated
| release_candidate: | ||
| # The version name is rendered before the below text via includes/header-notification.html | ||
| ' is currently available as a <a href="/admin/overview/about-upgrades-to-new-releases">release candidate</a>.' | ||
| release_candidate: ' is currently available as a <a href="/admin/overview/about-upgrades-to-new-releases">release candidate</a>.' |
There was a problem hiding this comment.
The leading space in the string value should be documented or reconsidered. According to the guidelines, variables like {% data variables.product.prodname_ghe_server %} should be used instead of hardcoded text where applicable. The version name that was previously rendered via includes/header-notification.html may need to be replaced with an appropriate variable.
How to review these changes 👓Thank you for your contribution. To review these changes, choose one of the following options: A Hubber will need to deploy your changes internally to review. Table of review linksNote: Please update the URL for your staging server or codespace. This pull request contains code changes, so we will not generate a table of review links. 🤖 This comment is automatically generated. |
Why:
Closes:
This PR is submitted to improve, refactor, and optimize the localization/configuration YAML used for GitHub Docs. The existing file contained minor inconsistencies, stray keys, and lacked structural comments for maintainers and translators. The refactor aims to enhance maintainability, clarity, and translation readiness for all stakeholders.
What's being changed (if available, include any code snippets, screenshots, or gifs):
{{icon}},{{query}}) are preserved and clearly documented.Example of the improved YAML file:
Check off the following: