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.

Sign up for GitHub

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

Jump to bottom

Make all docs have TOC on the right hand side. #3064

Merged
merged 2 commits into from
Oct 16, 2019
Merged

Make all docs have TOC on the right hand side. #3064

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ebd48d0
make all docs have a toc on the right. Add links to operating modes i…
tejal29 Oct 15, 2019
3c4918d
address balint's comment
tejal29 Oct 16, 2019
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
16 changes: 8 additions & 8 deletions docs/content/en/docs/concepts/modes/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,16 @@ weight: 30

This page discusses various operating modes of Skaffold.


Skaffold provides two separate operating modes:

* `skaffold dev`, the continuous development mode, enables monitoring of the
source repository, so that every time you make changes to the source code,
Skaffold will build and deploy your application.
* `skaffold run`, the standard mode, instructs Skaffold to build and deploy
your application exactly once. When you make changes to the source code,
you will have to call `skaffold run` again to build and deploy your
application.
## `skaffold dev`
A continuous development mode, enables monitoring of the source repository,
so that every time you make changes to the source code, Skaffold will build and deploy your application.

## `skaffold run`
A standard mode, instructs Skaffold to build and deploy your application exactly once.
When you make changes to the source code, you will have to call `skaffold run`
again to build and deploy your application.

Skaffold command-line interface also provides other functionalities that may
be helpful to your project. For more information, see [CLI References]({{< relref "/docs/references/cli" >}}).
Expand Down
2 changes: 1 addition & 1 deletion docs/content/en/docs/how-tos/buildpacks/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Buildpacks enable building language-based containers from source code, without t

## Before you begin
First, you will need to have Skaffold and a Kubernetes cluster set up.
To learn more about how to set up Skaffold and a Kubernetes cluster, see the [getting started docs](https://skaffold.dev/docs/getting-started/).
To learn more about how to set up Skaffold and a Kubernetes cluster, see the [getting started docs](/docs/getting-started/).
tejal29 marked this conversation as resolved.
Show resolved Hide resolved

To use buildpacks with Skaffold, please install the following additional tools:

Expand Down
6 changes: 3 additions & 3 deletions docs/content/en/docs/references/deprecation/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,8 +67,8 @@ Control API |alpha|Applications can control sync, build and deployment during in
[Debug]({{< relref "/docs/how-tos/debug" >}})|alpha|Language-aware reconfiguration of containers on the fly to become debuggable
[Default-repo]({{< relref "/docs/concepts/image_repositories" >}})|alpha|specify a default image repository & rewrite image names to default repo
Delete|beta |delete everything deployed by skaffold run from the cluster
[Deploy] ({{< relref "docs/how-tos/deployers" >}})|beta |Deploy a set of deployables as your applications and replace the image name with the built images
Dev|beta |Continuous development
[Deploy]({{< relref "docs/how-tos/deployers" >}})|beta |Deploy a set of deployables as your applications and replace the image name with the built images
[Dev](../../concepts/modes#skaffold-dev)|beta |Continuous development
tejal29 marked this conversation as resolved.
Show resolved Hide resolved
Diagnose|beta |Diagnose the current project and its configuration
Event API v1|alpha|Publish events and state of the application on gRPC and HTTP
[Filesync]({{< relref "/docs/how-tos/filesync" >}})|alpha|Instead of rebuilding, copy the changed files in the running container
Expand All @@ -79,7 +79,7 @@ Insecure registry handling|alpha |Target registries for built images which are n
[Profiles]({{< relref "/docs/how-tos/profiles" >}})|beta |Create different pipeline configurations based on overrides and patches defined in one or more profiles
skaffold build |beta |run skaffold build separately
skaffold fix|beta |Upgrade an older skaffold config to the current version
skaffold run|beta |One-off build & deployment of the skaffold application
[skaffold run](../../concepts/modes#skaffold-run)|beta |One-off build & deployment of the skaffold application
tejal29 marked this conversation as resolved.
Show resolved Hide resolved
[Tagpolicy]({{< relref "/docs/how-tos/taggers" >}})|beta |Automated tagging
[Test]({{< relref "/docs/how-tos/testers" >}})|alpha |Run tests as part of your pipeline
Trigger|alpha |Feature area: Trigger configured actions when source files change
Expand Down
6 changes: 6 additions & 0 deletions docs/layouts/partials/toc.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{{ partial "page-meta-links.html" . }}
{{ if not .Params.notoc }}
{{ with .TableOfContents }}
{{ . }}
{{ end }}
{{ end }}