Skip to content

Commit 5cedfa1

Browse files
authored
docs - quick patch (#14226)
* fix broken header link * add release notes button * fetch latest in button * fix version select offset * fix xss vuln: escape HTML
1 parent b8cec3f commit 5cedfa1

3 files changed

Lines changed: 33 additions & 6 deletions

File tree

docs/config/_default/menus/menus.en.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010

1111
[[main]]
1212
name = "Triage Findings ⏷"
13-
url = "/triage_findings/findings/intro_to_findings/"
13+
url = "/triage_findings/findings_workflows/intro_to_findings/"
1414
weight = 12
1515

1616
[[main]]

docs/layouts/_partials/header/header.html

Lines changed: 30 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -141,10 +141,35 @@ <h5 class="offcanvas-title fw-bold" id="offcanvasNavMainLabel">{{ .Site.Params.T
141141
<span class="ms-2 text-bs-body fw-bold">| docs</span>
142142
</span>
143143

144+
<!-- Release Notes -->
145+
<div class="flex-grow-1 d-none d-lg-flex justify-content-center align-items-center">
146+
{{ $url := "https://api.github.com/repos/DefectDojo/django-DefectDojo/releases/latest" }}
147+
{{ $resource := resources.GetRemote $url }}
148+
149+
{{ if $resource }}
150+
{{ $release := $resource | transform.Unmarshal | default dict }}
151+
{{ if $release.name }}
152+
{{ $release.name | htmlEscape }} |
153+
{{ else }}
154+
{{ printf "⚠️ Could not parse release name (not valid JSON or missing field)\n" | warnf }}
155+
{{ printf "Media Type: %s\n" $resource.MediaType | warnf }}
156+
{{ $contentPreview := substr $resource.Content 0 500 }}
157+
{{ printf "Content Preview (first 500 chars):\n%s\n" $contentPreview | warnf }}
158+
{{ end }}
159+
{{ else }}
160+
{{ printf "❌ Release Notes Fetch failed from: %s\n" $url | warnf }}
161+
{{ end }}
162+
<a href="/changelog/pro_changelog/">
163+
<button type="button" class="btn btn-link nav-link p-2 d-none d-lg-block" aria-label="Release Notes">
164+
<span class="fw-bold">Release Notes</span>
165+
</button>
166+
</a>
167+
</div>
168+
144169
<!-- Search -->
145170
<div class="flex-grow-1 d-none d-lg-flex justify-content-center align-items-center">
146171
<div class="d-flex align-items-center border rounded px-3">
147-
172+
148173
<!-- FlexSearch desktop -->
149174
{{ partial "main/showFlexSearch" . }}
150175
{{ $showFlexSearch := .Scratch.Get "showFlexSearch" -}}
@@ -225,7 +250,8 @@ <h5 class="offcanvas-title fw-bold" id="offcanvasNavMainLabel">{{ .Site.Params.T
225250
{{ $isTranslated := in $translatedLangs .Lang -}}
226251
<li><a class="dropdown-item {{ if not $isTranslated }}untranslated{{ end }}" rel="alternate"
227252
href="{{ if $isTranslated }}{{ (index (where $.Translations " Lang" .Lang) 0).RelPermalink }}{{ else
228-
}}{{ .Lang | relURL }}{{ end }}" hreflang="{{ .Lang }}" lang="{{ .Lang }}">{{ .LanguageName }}</a>
253+
}}{{ .Lang | relURL }}{{ end }}" hreflang="{{ .Lang }}" lang="{{ .Lang }}">{{ .LanguageName
254+
}}</a>
229255
</li>
230256
{{- end }}
231257
{{- end }}
@@ -316,7 +342,8 @@ <h5 class="offcanvas-title fw-bold" id="offcanvasNavMainLabel">{{ .Site.Params.T
316342
<!-- Navbar button mobile -->
317343
{{ if site.Params.doks.navBarButton -}}
318344
<a class="btn btn-primary rounded-pill mt-2 btn-block d-lg-none"
319-
href="{{ site.Params.doks.navBarButtonUrl | absURL }}" role="button">{{ site.Params.doks.navBarButtonText
345+
href="{{ site.Params.doks.navBarButtonUrl | absURL }}" role="button">{{
346+
site.Params.doks.navBarButtonText
320347
}}</a>
321348
{{ end -}}
322349
</div>

docs/layouts/_partials/sidebar/section-menu.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@
1313
{{- end }}
1414

1515
<!-- Version selector dropdown -->
16-
<nav class="docs-version-toggle mb-3" style="padding-top: 1rem;">
17-
<label for="version-select" class="form-label">DefectDojo Version</label>
16+
<nav class="docs-version-toggle mb-3">
17+
<label for="version-select" class="form-label" style="padding-top: 2.5rem;">DefectDojo Version</label>
1818
<select id="version-select" name="version" class="form-select" aria-label="Select documentation version">
1919
<option value="opensource">DefectDojo Open Source</option>
2020
<option value="pro">DefectDojo Pro</option>

0 commit comments

Comments
 (0)