diff --git a/docs/content/en/docs/concepts/modes/_index.md b/docs/content/en/docs/concepts/modes/_index.md index b8d8a9d43a1..986ea345bca 100755 --- a/docs/content/en/docs/concepts/modes/_index.md +++ b/docs/content/en/docs/concepts/modes/_index.md @@ -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" >}}). diff --git a/docs/content/en/docs/how-tos/buildpacks/_index.md b/docs/content/en/docs/how-tos/buildpacks/_index.md index 4342e2a740b..ccd3eabf7b8 100644 --- a/docs/content/en/docs/how-tos/buildpacks/_index.md +++ b/docs/content/en/docs/how-tos/buildpacks/_index.md @@ -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 [quickstart docs]({{< relref "/docs/quickstart" >}}). To use buildpacks with Skaffold, please install the following additional tools: diff --git a/docs/content/en/docs/references/deprecation/_index.md b/docs/content/en/docs/references/deprecation/_index.md index c4609d5c225..bbccc6050c9 100644 --- a/docs/content/en/docs/references/deprecation/_index.md +++ b/docs/content/en/docs/references/deprecation/_index.md @@ -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]({{< relref "/docs/concepts/modes#skaffold-dev" >}})|beta |Continuous development 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 @@ -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]({{< relref "/docs/concepts/modes#skaffold-run" >}})|beta |One-off build & deployment of the skaffold application [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 diff --git a/docs/layouts/partials/toc.html b/docs/layouts/partials/toc.html new file mode 100644 index 00000000000..67a2c8cdaa7 --- /dev/null +++ b/docs/layouts/partials/toc.html @@ -0,0 +1,6 @@ +{{ partial "page-meta-links.html" . }} +{{ if not .Params.notoc }} +{{ with .TableOfContents }} +{{ . }} +{{ end }} +{{ end }} \ No newline at end of file