Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[docs] fix alerts #3159

Merged
merged 1 commit into from
Nov 4, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/content/en/docs/design/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <code>grpc.WithInSecure()</code>
The skaffold gRPC server is not an HTTPS service, hence we need to specify `grpc.WithInSecure()`
{{</alert>}}

```golang
Expand Down Expand Up @@ -226,4 +226,4 @@ func main() {

### Controlling Build/Sync/Deploy

TODO: https://github.com/GoogleContainerTools/skaffold/issues/3143
TODO: https://github.com/GoogleContainerTools/skaffold/issues/3143
4 changes: 2 additions & 2 deletions docs/content/en/docs/install/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <a href=/docs/references/privacy#update-check>these instructions</a>.
You can turn this update check off by following [these instructions]({{<relref "/docs/references/privacy#update-check">}}).

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 <a href=https://policies.google.com/privacy>Google Privacy Policy</a>
{{< /alert >}}


Expand Down
2 changes: 1 addition & 1 deletion docs/content/en/docs/pipeline-stages/builders.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
<code>build</code> or <code>dockerBuild</code> goal to the <em>package</em> 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 >}}

Expand Down
4 changes: 2 additions & 2 deletions docs/content/en/docs/pipeline-stages/taggers.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,8 +76,8 @@ image.
{{< alert >}}
<b>Note</b><br>

<code>IMAGE_NAME</code> is a built-in variable whose value is the <code>imageName</code> field in
the <code>artifacts</code> part of the <code>build</code> section.
`IMAGE_NAME` is a built-in variable whose value is the `imageName` field in
the `artifacts` part of the `build` section.
{{< /alert >}}

### Example
Expand Down
6 changes: 3 additions & 3 deletions docs/content/en/docs/quickstart/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <code>Docker</code> and <code>kubectl</code>, Skaffold also supports a variety of other tools
and workflows; see <a href="/docs/tutorials">Tutorials</a> for
Aside from `Docker` and `kubectl`, Skaffold also supports a variety of other tools
and workflows; see [Tutorials]({{<relref "/docs/tutorials">}}) for
more information.
{{</alert>}}

Expand Down Expand Up @@ -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:
: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:
6 changes: 6 additions & 0 deletions docs/layouts/shortcodes/alert.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{{ $_hugo_config := `{ "version": 1 }` }}
{{ $color := .Get "color" | default "primary" }}
<div class="alert alert-{{ $color }}" role="alert">
{{ with .Get "title" }}<h4 class="alert-heading">{{ . | safeHTML }}</h4>{{ end }}
{{ .Inner | markdownify }}
</div>