Skip to content

Commit d06fcaa

Browse files
committed
fixing docs due to upgrade in Hugo
1 parent 0dd1c30 commit d06fcaa

File tree

5 files changed

+22
-9
lines changed

5 files changed

+22
-9
lines changed

deploy/docs-v2/build.sh

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,4 +22,10 @@ cd docs-v2
2222
mkdir -p themes
2323
ln -s /app/docs/themes/docsy ./themes/docsy
2424
ln -s /app/docs/node_modules ./node_modules
25+
26+
# Hugo was updated to be more strict about shortcodes.
27+
# to prevent changing existing structure, we will copy over the files before hugo invocation.
28+
mkdir -p layouts/partials/shortcodes
29+
cp -r layouts/shortcodes layouts/partials/
30+
2531
hugo --baseURL=${BASE_URL}

deploy/webhook-v2/Dockerfile

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,16 +14,19 @@
1414

1515
# Download Docsy theme for Hugo
1616
FROM alpine:3.10 AS download-docsy
17-
# v0.3.0
18-
ENV DOCSY_VERSION=9f55cf34808d720bcfff9398c9f9bb7fd8fce4ec
17+
# v0.14.1
18+
ENV DOCSY_VERSION=v0.14.1
1919
ENV DOCSY_URL=https://github.com/google/docsy.git
20-
RUN apk add --no-cache git
20+
RUN apk add --no-cache git npm
2121
WORKDIR /docsy
2222
RUN git clone "${DOCSY_URL}" . && \
23-
git reset --hard "${DOCSY_VERSION}" && \
24-
git submodule update --init --recursive && \
23+
git checkout "${DOCSY_VERSION}" && \
24+
git submodule update --init --recursive --force && \
2525
rm -rf .git
2626

27+
# vendors are installed via npm.
28+
RUN npm install
29+
2730
# Download Hugo
2831
FROM alpine:3.10 AS download-hugo
2932
ENV HUGO_VERSION=0.155.3

docs-v2/config.toml

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,11 @@ Title = "Skaffold"
44

55
enableRobotsTXT = true
66

7-
# Hugo allows theme composition (and inheritance). The precedence is from left to right.
8-
theme = ["docsy"]
7+
# Use of Hugo modules to import Docsy.
8+
[module]
9+
replacements = "github.com/FortAwesome/Font-Awesome -> ., github.com/twbs/bootstrap -> ."
10+
[[module.imports]]
11+
path = "docsy"
912

1013
# Will give values to .Lastmod etc.
1114
enableGitInfo = true
@@ -72,6 +75,7 @@ id = "UA-120945544-1"
7275
title = "Skaffold"
7376
description = "Easy and Repeatable Container & Kubernetes Development"
7477
languageName ="English"
78+
contentDir = "content/en"
7579
# Weight used for sorting.
7680
weight = 1
7781

docs-v2/content/en/docs/install/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Your use of this software is subject to the [Google Privacy Policy](https://poli
2525

2626
{{% tab "CLOUD CODE" %}}
2727

28-
[Cloud Code](https://cloud.google.com/code) provides a managed experience of using Skaffold in supported IDEs. You can install the `Cloud Code` extension for [Visual Studio Code]([https://cloud.google.com/code/docs/vscode/quickstart-k8s#installing](https://cloud.google.com/code/docs/vscode/install#installing)) or the plugin for [JetBrains IDEs](https://cloud.google.com/code/docs/intellij/quickstart-k8s#installing_the_plugin). It manages and keeps Skaffold up-to-date, along with other common dependencies, and works with any kubernetes cluster.
28+
[Cloud Code](https://cloud.google.com/code) provides a managed experience of using Skaffold in supported IDEs. You can install the `Cloud Code` extension for [Visual Studio Code](https://cloud.google.com/code/docs/vscode/install) or the plugin for [JetBrains IDEs](https://cloud.google.com/code/docs/intellij/quickstart-k8s#installing_the_plugin). It manages and keeps Skaffold up-to-date, along with other common dependencies, and works with any kubernetes cluster.
2929

3030
{{% /tab %}}
3131

docs-v2/layouts/shortcodes/maturity-table.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
{{ if not $data.feature }}
1313
<tr>
1414
<td><a href="{{$data.url}}">{{$data.area}}</a></td>
15-
<td>{{ template "shortcodes/maturity-label.html" $data }}</td>
15+
<td>{{ partial "shortcodes/maturity-label.html" $data }}</td>
1616
<td>{{$data.description}}</td>
1717
</tr>
1818
{{end}}

0 commit comments

Comments
 (0)