Skip to content

Commit a59afc2

Browse files
authored
Use rendered docs URLs for release notes (#2117)
## Changes <!-- List the changes this PR makes. --> - This PR updates those URLs to the raw release notes so that they appear well formatted, making them easier to read for contributors and users. ### Files Changed - `hugo.yml` - `script/update-git-version.rb` - `layouts/shortcodes/install-header.html` Example before: https://github.com/git/git/raw/HEAD/Documentation/RelNotes/2.52.0.adoc Example after: https://gitlab.com/git-scm/git/-/blob/v2.52.0/Documentation/RelNotes/2.52.0.adoc ## Context The existing release notes URLs reference the raw AsciiDoc files on raw.githubusercontent.com, which renders as plain text without formatting. As a result, the release notes are harder to read. This update replaces those raw URLs with links to the rendered AsciiDoc view on the GitLab mirror, making the release notes more readable and user-friendly. The links now reference the tagged version (v2.52.0) to ensure they remain stable and accurately reflect the contents of the 2.52.0 release.
2 parents 76b2246 + 7e3dfcd commit a59afc2

File tree

3 files changed

+3
-3
lines changed

3 files changed

+3
-3
lines changed

hugo.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ params:
3838
hugo_version: 0.148.2
3939
pagefind_version: 1.4.0
4040
latest_version: 2.52.0
41-
latest_relnote_url: https://github.com/git/git/raw/HEAD/Documentation/RelNotes/2.52.0.adoc
41+
latest_relnote_url: https://gitlab.com/git-scm/git/-/blob/HEAD/Documentation/RelNotes/2.52.0.adoc
4242
latest_release_date: '2025-11-17'
4343
windows_installer:
4444
installer_x64:

layouts/shortcodes/install-header.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<h1>Install</h1>
55
<div class="version-badge">
66
Latest version: {{ site.Params.latest_version }}
7-
(<a href="https://github.com/git/git/blob/HEAD/Documentation/RelNotes/{{ site.Params.latest_version }}.adoc">Release Notes</a>)
7+
(<a href="{{ site.Params.latest_relnote_url }}">Release Notes</a>)
88
</div>
99
</div>
1010

script/update-git-version.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
config = YAML.load_file("hugo.yml")
2121
config["params"] = {} if config["params"].nil?
2222
config["params"]["latest_version"] = version
23-
config["params"]["latest_relnote_url"] = "https://github.com/git/git/raw/HEAD/Documentation/RelNotes/#{version}.adoc"
23+
config["params"]["latest_relnote_url"] = "https://gitlab.com/git-scm/git/-/blob/HEAD/Documentation/RelNotes/#{version}.adoc"
2424
config["params"]["latest_release_date"] = date.strftime("%Y-%m-%d")
2525
yaml = YAML.dump(config).gsub(/ *$/, "")
2626
File.write("hugo.yml", yaml)

0 commit comments

Comments
 (0)