From 51be78323f1c562ead5266de2bb198cafcdcf975 Mon Sep 17 00:00:00 2001 From: balopat Date: Sun, 3 Nov 2019 21:48:49 -0800 Subject: [PATCH] fix alerts --- docs/content/en/docs/design/api.md | 4 ++-- docs/content/en/docs/install/_index.md | 4 ++-- docs/content/en/docs/pipeline-stages/builders.md | 2 +- docs/content/en/docs/pipeline-stages/taggers.md | 4 ++-- docs/content/en/docs/quickstart/_index.md | 6 +++--- docs/layouts/shortcodes/alert.html | 6 ++++++ 6 files changed, 16 insertions(+), 10 deletions(-) create mode 100644 docs/layouts/shortcodes/alert.html diff --git a/docs/content/en/docs/design/api.md b/docs/content/en/docs/design/api.md index 1262aaf9ac7..9a5a02e26db 100644 --- a/docs/content/en/docs/design/api.md +++ b/docs/content/en/docs/design/api.md @@ -51,7 +51,7 @@ WARN[0000] port 50051 for gRPC server already in use: using 50053 instead To connect to the `gRPC` server at default port `50051` use the following code snippet. {{< alert title="Note" >}} -The skaffold gRPC server is not an HTTPS service, hence we need to specify grpc.WithInSecure() +The skaffold gRPC server is not an HTTPS service, hence we need to specify `grpc.WithInSecure()` {{}} ```golang @@ -226,4 +226,4 @@ func main() { ### Controlling Build/Sync/Deploy -TODO: https://github.com/GoogleContainerTools/skaffold/issues/3143 \ No newline at end of file +TODO: https://github.com/GoogleContainerTools/skaffold/issues/3143 diff --git a/docs/content/en/docs/install/_index.md b/docs/content/en/docs/install/_index.md index f4b4e3a47a6..914f4675444 100644 --- a/docs/content/en/docs/install/_index.md +++ b/docs/content/en/docs/install/_index.md @@ -8,10 +8,10 @@ weight: 1 To keep Skaffold up to date, update checks are made to Google servers to see if a new version of Skaffold is available. -You can turn this update check off by following these instructions. +You can turn this update check off by following [these instructions]({{}}). +Your use of this software is subject to the [Google Privacy Policy](https://policies.google.com/privacy) -Your use of this software is subject to the Google Privacy Policy {{< /alert >}} diff --git a/docs/content/en/docs/pipeline-stages/builders.md b/docs/content/en/docs/pipeline-stages/builders.md index 5c668c066db..c0a84d3894c 100755 --- a/docs/content/en/docs/pipeline-stages/builders.md +++ b/docs/content/en/docs/pipeline-stages/builders.md @@ -206,7 +206,7 @@ in Maven) that should produce a container image. Then for each such sub-project: {{< alert title="Updating from earlier versions" >}} Skaffold had required Maven multi-module projects bind a Jib -build or dockerBuild goal to the package phase. These bindings are +`build` or `dockerBuild` goal to the **package** phase. These bindings are no longer required with Jib 1.4.0 and should be removed. {{< /alert >}} diff --git a/docs/content/en/docs/pipeline-stages/taggers.md b/docs/content/en/docs/pipeline-stages/taggers.md index 17950ac56c6..2886e807d56 100644 --- a/docs/content/en/docs/pipeline-stages/taggers.md +++ b/docs/content/en/docs/pipeline-stages/taggers.md @@ -76,8 +76,8 @@ image. {{< alert >}} Note
-IMAGE_NAME is a built-in variable whose value is the imageName field in -the artifacts part of the build section. +`IMAGE_NAME` is a built-in variable whose value is the `imageName` field in +the `artifacts` part of the `build` section. {{< /alert >}} ### Example diff --git a/docs/content/en/docs/quickstart/_index.md b/docs/content/en/docs/quickstart/_index.md index 37a9a296879..68b1704faec 100644 --- a/docs/content/en/docs/quickstart/_index.md +++ b/docs/content/en/docs/quickstart/_index.md @@ -8,8 +8,8 @@ Follow this tutorial to learn about Skaffold on a small Kubernetes app built wit and deployed with [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/)! {{< alert title="Note">}} -Aside from Docker and kubectl, Skaffold also supports a variety of other tools -and workflows; see Tutorials for +Aside from `Docker` and `kubectl`, Skaffold also supports a variety of other tools +and workflows; see [Tutorials]({{}}) for more information. {{}} @@ -149,4 +149,4 @@ using [Builders](/docs/pipeline-stages/builders), [Taggers](/docs/pipeline-stage [Skaffold Tutorials]({{< relref "/docs/tutorials" >}}) details some of the common use cases of Skaffold. -:mega: **Please fill out our [quick 5-question survey](https://forms.gle/BMTbGQXLWSdn7vEs6)** to tell us how satisfied you are with Skaffold, and what improvements we should make. Thank you! :dancers: \ No newline at end of file +:mega: **Please fill out our [quick 5-question survey](https://forms.gle/BMTbGQXLWSdn7vEs6)** to tell us how satisfied you are with Skaffold, and what improvements we should make. Thank you! :dancers: diff --git a/docs/layouts/shortcodes/alert.html b/docs/layouts/shortcodes/alert.html new file mode 100644 index 00000000000..7360be16352 --- /dev/null +++ b/docs/layouts/shortcodes/alert.html @@ -0,0 +1,6 @@ +{{ $_hugo_config := `{ "version": 1 }` }} +{{ $color := .Get "color" | default "primary" }} +