istio / istio.io

Source for the istio.io site
https://istio.io/
Apache License 2.0
761 stars 1.54k forks source link

Add proper cleanup instructions to all docs #11720

Open frankbu opened 2 years ago

frankbu commented 2 years ago

The cleanup instructions in various docs are missing. Some docs do complete uninstall, some do partial, and some have no cleanup instructions at all. The ones that have partial or no instructions have cleanup commands in the test.sh (but many of those are only partially correct, just enough to pass the before/after snapshot diff).

We need do a pass through all of the docs to make sure they include proper cleanup instructions and then cleanup the tests to call the cleanup snips instead coding the cleanup commands themselves.

frankbu commented 2 years ago

These are the docs that have no cleanup instructions at all:

content/en/docs//tasks/observability/metrics/customize-metrics/index.md
content/en/docs//tasks/traffic-management/ingress/gateway-api/index.md
content/en/docs//setup/additional-setup/cni/index.md
content/en/docs//setup/additional-setup/gateway/index.md
content/en/docs/setup/install/multicluster/
content/en/docs//examples/virtual-machines/index.md
content/en/docs/ops/configuration/mesh/config-resource-ready/index.md
content/en/docs/ops/configuration/security/security-policy-examples/index.md
content/en/docs/ops/configuration/telemetry/envoy-stats/index.md
content/en/docs//ops/configuration/traffic-management/network-topologies/index.md
content/en/docs/ops/diagnostic-tools/istioctl-analyze/index.md

Some are ops docs, which might be OK.

johnma14 commented 1 year ago

Linking related issues here for tracking purposes:

jaellio commented 1 year ago

@frankbu Can this issue be closed?