Skip to content

Comments

Refactor and Optimize GitHub Docs Localization YAML#39402

Closed
NirajDN wants to merge 3 commits intogithub:mainfrom
NirajDN:patch-4
Closed

Refactor and Optimize GitHub Docs Localization YAML#39402
NirajDN wants to merge 3 commits intogithub:mainfrom
NirajDN:patch-4

Conversation

@NirajDN
Copy link
Contributor

@NirajDN NirajDN commented Jul 19, 2025

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):

  • Improved formatting and indentation for clarity and consistency.
  • Removed stray or unclear keys (such as "can we improve this code?").
  • Added explanatory comments for maintainers and translators at the top of the YAML file.
  • Ensured all placeholders (like {{icon}}, {{query}}) are preserved and clearly documented.
  • Grouped related configuration keys together to improve readability and future edits.
  • Verified YAML for structural validity—no breaking changes or value loss.
  • No content or functional changes to user-facing text; all changes are organizational and non-breaking.

Example of the improved YAML file:

# See the full file in this PR for details
meta:
  default_description: Get started, troubleshoot, and make the most of GitHub. ...
header:
  github_docs: GitHub Docs
  ...

Check off the following:

  • A subject matter expert (SME) has reviewed the technical accuracy of the content in this PR. In most cases, the author can be the SME. Open source contributions may require an SME review from GitHub staff.
  • The changes in this PR meet the docs fundamentals that are required for all content.
  • All CI checks are passing and the changes look good in the review environment.

Copilot AI review requested due to automatic review settings July 19, 2025 21:39
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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>.'
Copy link

Copilot AI Jul 19, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copilot generated this review using guidance from repository custom instructions.
@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Jul 19, 2025
@github-actions
Copy link
Contributor

github-actions bot commented Jul 19, 2025

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 links

Note: 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.

@NirajDN NirajDN closed this Jul 19, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

triage Do not begin working on this issue until triaged by the team

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant