updated all infopanels

ktarplee · Nov 5, 2019 · 3c90c9e · 3c90c9e
1 parent 6288cd0
commit 3c90c9e
Show file tree

Hide file tree

Showing 24 changed files with 660 additions and 127 deletions.
diff --git a/Makefile b/Makefile
@@ -236,7 +236,7 @@ submit-release-trigger:
 
 .PHONY: preview-docs
 preview-docs:
-	./deploy/docs/local-preview.sh hugo serve -D --bind=0.0.0.0
+	./deploy/docs/local-preview.sh hugo serve -D --bind=0.0.0.0 --ignoreCache
 
 .PHONY: build-docs-preview
 build-docs-preview:
@@ -250,4 +250,4 @@ generate-schemas:
 
 .PHONY: generate-licenses
 generate-licenses:
-	hack/gen_licenses.sh
+	hack/gen_licenses.sh
diff --git a/docs/content/en/docs/design/api.md b/docs/content/en/docs/design/api.md
@@ -3,12 +3,9 @@ title: "Skaffold API"
 linkTitle: "Skaffold API"
 weight: 60
 
-maturity: alpha
-
 infopanel: true
+featureId: api
 applicability: true
-dev: true
-debug: true
 ---
 When running [`skaffold dev`]({{< relref "/docs/workflows/dev" >}}) or [`skaffold debug`]({{< relref "/docs/workflows/debug" >}}), 
 Skaffold starts a server that exposes an API over the lifetime of the Skaffold process.
@@ -88,7 +85,6 @@ Skaffold's API exposes the three main endpoints:
 * Control API - control build/deploy/sync
 
 ### Events API
-{{< alpha >}}
 
 Skaffold provides a continuous development mode [`skaffold dev`]({{< relref "/docs/workflows/dev" >}}) which rebuilds and redeploys
 your application on changes. In a single development loop, one or more container images
@@ -159,7 +155,6 @@ a string description of the event in `LogEntry.entry` field.
 
 
 ### State API
-{{< beta >}}
 
 The State API provides a snapshot of the current state of the following components:
 
@@ -234,6 +229,5 @@ func main() {
 {{% /tabs %}}
 
 ### Control API
-{{< alpha >}}
 
 TODO: https://github.com/GoogleContainerTools/skaffold/issues/3143
diff --git a/docs/content/en/docs/design/global-config.md b/docs/content/en/docs/design/global-config.md
@@ -3,11 +3,9 @@ title: "Global configuration"
 linkTitle: "Global configuration"
 weight: 50
 
-maturity: beta
-
 infopanel: true
+featureId: global_config
 applicability: true
-all: true
 ---
 
 Some context specific settings can be configured in a global configuration file, which defaults to `~/.skaffold/config`. Options can be configured globally or for specific Kubernetes contexts.

diff --git a/docs/content/en/docs/environment/image-registries.md b/docs/content/en/docs/environment/image-registries.md
@@ -2,10 +2,10 @@
 title: "Image repository handling"
 linkTitle: "Image repository handling"
 weight: 70
+
 infoPanel: true
-maturity: alpha
-applicability: true 
-all: true
+featureId: default_repo
+applicability: true
 ---
 
 Often, a Kubernetes manifest (or `skaffold.yaml`) makes references to images that push to

diff --git a/docs/content/en/docs/environment/profiles.md b/docs/content/en/docs/environment/profiles.md
@@ -2,10 +2,10 @@
 title: "Profiles"
 linkTitle: "Profiles"
 weight: 70
+
 infoPanel: true
-maturity: GA 
+featureId: profiles
 applicability: true
-all: true
 ---
 
 Skaffold profiles allow you to define build, test and deployment

diff --git a/docs/content/en/docs/environment/templating.md b/docs/content/en/docs/environment/templating.md
@@ -2,6 +2,10 @@
 title: "Templated fields"
 linkTitle: "Templated fields"
 weight: 90
+
+infoPanel: true
+featureId: templating
+applicability: true
 ---
 
 Skaffold allows for certain fields in the config to be templated with values either from environment variables, or certain special values computed by Skaffold.

diff --git a/docs/content/en/docs/pipeline-stages/builders.md b/docs/content/en/docs/pipeline-stages/builders.md
@@ -3,14 +3,9 @@ title: "Build"
 linkTitle: "Build"
 weight: 10
 
-maturity: GA
-
 infoPanel: true
+featureId: build
 applicability: true
-dev: true
-debug: true
-build: true
-run: true
 ---
 
 Skaffold has native support for several different tools for building images:

diff --git a/docs/content/en/docs/pipeline-stages/deployers.md b/docs/content/en/docs/pipeline-stages/deployers.md
@@ -3,13 +3,9 @@ title: "Deploy"
 linkTitle: "Deploy"
 weight: 30
 
-maturity: GA
-
 infoPanel: true
+featureId: deploy
 applicability: true
-dev: true
-deploy: true
-debug: true
 ---
 
 When Skaffold deploys your application, it goes through these steps:

diff --git a/docs/content/en/docs/pipeline-stages/filesync.md b/docs/content/en/docs/pipeline-stages/filesync.md
@@ -3,11 +3,9 @@ title: "File sync"
 linkTitle: "File sync"
 weight: 40
 
-maturity: alpha 
-
 infoPanel: true
+featureId: sync
 applicability: true
-dev: true
 ---
 
 Skaffold supports copying changed files to a deployed container so as to avoid the need to rebuild, redeploy, and restart the corresponding pod.

diff --git a/docs/content/en/docs/pipeline-stages/logging.md b/docs/content/en/docs/pipeline-stages/logging.md
@@ -3,11 +3,7 @@ title: "Logging"
 linkTitle: "Logging"
 weight: 40
 
-maturity: GA
-
 infoPanel: true
+featureId: logging
 applicability: true
-dev: true
-debug: true
-run: true
 ---
diff --git a/docs/content/en/docs/pipeline-stages/port-forwarding.md b/docs/content/en/docs/pipeline-stages/port-forwarding.md
@@ -3,12 +3,9 @@ title: "Port forwarding"
 linkTitle: "Port forwarding"
 weight: 50
 
-maturity: beta
-
 infoPanel: true
+featureId: portforward
 applicability: true
-dev: true
-debug: true
 ---
 
 Skaffold has built-in support for forwarding ports for exposed Kubernetes resources on your cluster

diff --git a/docs/content/en/docs/pipeline-stages/taggers.md b/docs/content/en/docs/pipeline-stages/taggers.md
@@ -6,10 +6,8 @@ weight: 15
 maturity: GA
 
 infoPanel: true
+featureId: tagpolicy
 applicability: true
-dev: true
-debug: true
-build: true
 ---
 
 Skaffold supports the following policies for tagging images:

diff --git a/docs/content/en/docs/pipeline-stages/testers.md b/docs/content/en/docs/pipeline-stages/testers.md
@@ -3,13 +3,9 @@ title: "Test"
 linkTitle: "Test"
 weight: 20
 
-maturity: beta
-
 infoPanel: true
+featureId: test
 applicability: true
-dev: true
-build: true
-run: true
 ---
 
 It's common practice to validate built container images before deploying them to our cluster.

diff --git a/docs/content/en/docs/references/deprecation/_index.md b/docs/content/en/docs/references/deprecation/_index.md
@@ -4,8 +4,6 @@ linkTitle: "Deprecation policy"
 weight: 300
 ---
 
-# Skaffold deprecation policy
-
 This document sets out the deprecation policy for Skaffold, and outlines how the Skaffold project will approach the introduction of breaking changes over time.
 
 Deprecation policy applies only to Stable Builds. Bleeding Edge builds may have less stable implementations.  
@@ -60,49 +58,7 @@ However the **behavior** of individual component might suffer breaking changes d
 
 The following is the maturity of the larger feature areas: 
 
-|area|state|description|
-|----|----|----|
-[Build]({{< relref "/docs/pipeline-stages/builders" >}})|beta |Build images based on multiple build tools in a configurable way
-Control API |alpha|Applications can control sync, build and deployment during instead of automated sync, build and deploy
-[Debug]({{< relref "/docs/workflows/debug.md" >}})|alpha|Language-aware reconfiguration of containers on the fly to become debuggable
-[Default-repo]({{< relref "/docs/environment/image-registries.md" >}})|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/pipeline-stages/deployers" >}})|beta |Deploy a set of deployables as your applications and replace the image name with the built images
-Render |alpha| Skaffold render outputs rendered kubernetes manifests|
-[Dev]({{< relref "/docs/workflows/dev.md" >}})|beta |Continuous development
-[Event API v1]({{<relref "docs/design/api#events-api" >}})|alpha|Publish events and state of the application on gRPC and HTTP
-[Filesync]({{< relref "/docs/pipeline-stages/filesync" >}})|alpha|Instead of rebuilding, copy the changed files in the running container
-[Global config]({{< relref "/docs/design/config" >}})|alpha|store user preferences in a separate preferences file
-Init|alpha|Initialize a skaffold.yaml file based on the contents of the current directory
-Insecure registry handling|alpha |Target registries for built images which are not secure
-[Port-forwarding]({{< relref "/docs/pipeline-stages/port-forwarding.md" >}})|alpha |Port forward application to localhost
-[Profiles]({{< relref "/docs/environment/profiles.md" >}})|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
-[Tagpolicy]({{< relref "/docs/pipeline-stages/taggers" >}})|beta |Automated tagging
-[Test]({{< relref "/docs/pipeline-stages/testers" >}})|alpha |Run tests as part of your pipeline
-Trigger|alpha |Feature area: Trigger configured actions when source files change
-version|beta|get the version string of the current skaffold binary
-[Templating]({{< relref "/docs/environment/templating.md" >}})|alpha|certain fields of skaffold.yaml can be parametrized with environment and built-in variables
-
-Within a feature area we do have certain features that are expected to change: 
-
-|area|feature|state|description|
-|----|----|----|----|
-Build | buildpacks native support|alpha| Skaffold natively support for buildpacks artifact and buildpacks builder
-Debug|debug python apps|alpha|debug python apps
-Debug|debug node apps|alpha|debug node apps
-Debug|debug java apps|alpha|debug java apps
-Debug|debug go apps|alpha|debug go apps
-Default-repo|preconcatentation strategy|beta|collision free rewriting strategy
-Tagpolicy|latest tagger|alpha|tag with latest, use image digest / image ID for deployment
-Tagpolicy|contentDigest tagger|alpha|reintroduce DIGEST and content based digest tag
-Filesync|sync.infer|alpha|mark files as "syncable" - infer the destinations based on the Dockerfile
-Init|json based |alpha|skaffold init JSON based API for IDE integrations
-Init|interactive|alpha|skaffold init interactive for CLI users
-Init|init for k8s manifests|alpha|skaffold init recognizes k8s manifest and the image names in them
-Init|init for Dockerfiles |alpha|skaffold init recognizes Dockerfiles
+{{< maturity-table >}}
 
 ## Exceptions 
 
@@ -128,4 +84,4 @@ This flag will will be removed earliest 06/15/2019.
 - `DIGEST_ALGO`
 - `DIGEST_HEX`
 Currently these variables resolve to `_DEPRECATED_<envvar>_`, and the new tagging mechanism adds a digest to the image name thus it shouldn't break existing configurations.
-This backward compatibility behavior will be removed earliest 05/14/2019.
+This backward compatibility behavior will be removed earliest 05/14/2019.
diff --git a/docs/content/en/docs/workflows/ci-cd.md b/docs/content/en/docs/workflows/ci-cd.md
@@ -3,15 +3,6 @@ title: "CI/CD with Skaffold"
 linkTitle: "CI/CD with Skaffold"
 weight: 30
 
-maturity: beta
-
-infoPanel: true
-applicability: true
-
-build: true
-deploy: true
-render: true
-run: true
 ---
 
 Skaffold offers several sub-commands for its workflows that make it quite flexible when integrating with CI/CD pipelines.
@@ -56,8 +47,9 @@ Starting deploy...
  - pod/getting-started configured
 ```
 
+
 ## `skaffold render` 
-{{< alpha >}}
+{{< maturity "render" >}}
 
 Skaffold also has another built-in command, `skaffold render`, that will perform builds on all artifacts in your project, template the newly built image tags into your Kubernetes deployment configuration files (based on your configured deployer), and instead of sending these through the deployment process, print out the final deployment artifacts. This allows your to snapshot your project's builds, but also integrate those builds into your deployment configs to snapshot your deployment as well. This can be very useful when integrating with GitOps based workflows: these templated deployment configurations can be committed to a Git repository as a way to deploy using GitOps.
 

diff --git a/docs/content/en/docs/workflows/debug.md b/docs/content/en/docs/workflows/debug.md
@@ -3,11 +3,9 @@ title: "Debugging with Skaffold"
 linkTitle: "Debugging"
 weight: 20
 
-maturity: alpha 
-
 infoPanel: true
-debug: true
-applicability: true 
+featureId: debug
+applicability: true
 ---
 
 `skaffold debug` acts like `skaffold dev`, but it configures containers in pods

diff --git a/docs/content/en/docs/workflows/dev.md b/docs/content/en/docs/workflows/dev.md
@@ -3,11 +3,9 @@ title: "skaffold dev"
 linkTitle: "Continuous development"
 weight: 10
 
-maturity: GA
-
 infoPanel: true
+featureId: dev
 applicability: true
-dev: true
 ---
 
 `skaffold dev` enables continuous local development on an application.