Skip to content

Commit 9f18581

Browse files
hkad98hkad98
authored
Merge pull request #1147 from ParzivalPavlis/docs/fix2-htmltest
docs: ensure valid links in API reference and sidebar navigation
2 parents 533a6c7 + b59c506 commit 9f18581

File tree

5 files changed

+41
-4
lines changed

5 files changed

+41
-4
lines changed

‎docs/layouts/partials/api-ref-link-all-partial.html‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
{{ $links := . }}
99

1010
{{ range $name, $data := $links }}
11+
{{ if and $data.path (ne $data.path "") }}
1112
{{ $path := $data.path }}
1213
{{ $kind := $data.kind }}
1314
{{/* I don't think there is any other way to include literal backtick inside a raw-string */}}
@@ -29,6 +30,7 @@
2930
{{ $a_html := (printf "$1<a href=\"%s/\">%s</a>$3" $path $name) }}
3031
{{ $paragraph = replaceRE $pattern $a_html $paragraph | safeHTML}}
3132
{{ end }}
33+
{{ end }}
3234
{{ end }}
3335

3436
{{/* Remove backticks around links */}}

‎docs/layouts/partials/api-ref-link-partial.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
{{ $name := replace $name "List[" "" }}
1515

1616
{{ $data := index $links (trim $name " ") }}
17-
{{ if $data }}
17+
{{ if and $data $data.path (ne $data.path "") }}
1818
{{ $path := $data.path }}
1919
{{ $a_html := (printf "<a href=\"%s/\">%s</a>" $path $name) }}
2020
{{ replace $orig_name $name $a_html | safeHTML}}

‎docs/layouts/partials/header-menu.html‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
<nav class="gd-docs-header-nav__center gd-header" aria-label="Main">
2+
<input type="checkbox" role="button" id="gd-header-mobile-menu-trigger-input" name="gd-header-mobile-menu-trigger-input" class="gd-header-mobile gd-header-mobile-menu-trigger-input" aria-label="Open navigation menu" aria-controls="gd-header-mobile-menu" aria-expanded="false">
3+
<label tabindex="0" for="gd-header-mobile-menu-trigger-input" class="gd-header-mobile gd-header-mobile-menu-trigger"><span></span></label>
4+
<ul class="gd-docs-header-nav__menu gd-header-links">
5+
<li class="gd-docs-header-nav__menuitem gd-header-link-item gd-header-link-item-mobile-only">
6+
<a href="https://www.gooddata.com/learn/" class="gd-docs-header-nav__menulink gd-header-link gd-header-link__main">Learn</a>
7+
</li>
8+
<li class="gd-docs-header-nav__menuitem gd-header-link-item">
9+
<a href="https://university.gooddata.com/" class="gd-docs-header-nav__menulink gd-header-link">University</a>
10+
</li>
11+
<li class="gd-docs-header-nav__menuitem gd-header-link-item">
12+
<a href="https://community.gooddata.com/" class="gd-docs-header-nav__menulink gd-header-link">Community</a>
13+
</li>
14+
<li class="gd-docs-header-nav__menuitem gd-header-link-item">
15+
<a href="https://www.gooddata.com/docs/python-sdk" class="gd-docs-header-nav__menulink gd-header-link gd-header-link__active">Documentation</a>
16+
</li>
17+
<li class="gd-docs-header-nav__menuitem gd-header-link-item">
18+
<a href="https://support.gooddata.com/hc/en-us" class="gd-docs-header-nav__menulink gd-header-link">Support</a>
19+
</li>
20+
<li class="gd-docs-header-nav__menuitem gd-header-link-item gd-header-link-item-mobile-only">
21+
<a href="https://www.gooddata.com/" class="button">Go to GoodData.com</a>
22+
</li>
23+
</ul>
24+
</nav>

‎docs/layouts/partials/navbar-version-selector.html‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,16 +9,21 @@
99
{{ $.Scratch.Set "activeVersion" .version }}
1010
{{ end }}
1111
{{ end }}
12+
13+
{{ if .Site.Params.versions }}
1214
<button class="nav-link dropdown-toggle" id="navbarDropdown" role="button" data-toggle="dropdown" data-bs-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
1315
{{ printf "%s" ($.Scratch.Get "docLabel") }}
1416
</button>
1517
<div class="dropdown-menu" aria-labelledby="navbarDropdownMenuLink">
1618
{{ range .Site.Params.versions }}
19+
{{ if and .url (ne .url "") }}
1720
<a
1821
class="dropdown-item{{ if eq ( $.Scratch.Get "activeVersion" ) ( printf "%s" .version ) }} active{{ end }}"
1922
href="{{ cond (gt (len (findRE "^http(s)?://" .url)) 0) .url (relURL .url) }}"
2023
>
2124
{{ .version }}
2225
</a>
2326
{{ end }}
27+
{{ end }}
2428
</div>
29+
{{ end }}

‎docs/layouts/partials/sidebar.html‎

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,11 @@
1818
<ul class="gd-docs-menu-section gd-docs-menu-section__root">
1919
<li class="gd-docs-menu-page{{ if or $isCurrent $active }} active{{ end }}">
2020
<div class="gd-docs-menu-page__title">
21+
{{- if and .RelPermalink (ne .RelPermalink "") -}}
2122
<a href="{{ .RelPermalink }}" class="gd-docs-menu-page__link">{{ .LinkTitle }}</a>
23+
{{- else -}}
24+
<span class="gd-docs-menu-page__link">{{ .LinkTitle }}</span>
25+
{{- end }}
2226
</div>
2327
</li>
2428
</ul>
@@ -49,11 +53,13 @@
4953
<span class="gd-docs-menu-page__label">{{ $page.LinkTitle }}</span>
5054
{{ else }}
5155
<div class="gd-docs-menu-page__title">
52-
{{ if $page.Params.externalLink }}
56+
{{- if and $page.Params.externalLink (ne $page.Params.externalLink "") -}}
5357
<a href="{{ $page.Params.externalLink }}" class="gd-docs-menu-page__link" target="_blank">{{ $page.LinkTitle }}</a>
54-
{{ else }}
58+
{{- else if and $page.Permalink (ne $page.Permalink "") -}}
5559
<a href="{{ $page.Permalink }}" class="gd-docs-menu-page__link">{{ $page.LinkTitle }}</a>
56-
{{ end }}
60+
{{- else -}}
61+
<span class="gd-docs-menu-page__link">{{ $page.LinkTitle }}</span>
62+
{{- end }}
5763

5864
{{ if $page.Pages }}
5965
<button

0 commit comments

Comments
 (0)