docs: update doc organization strcture for easy access

kubernetes-sigs · Mar 8, 2023 · 44f4c6b · 44f4c6b
1 parent 61334e1
commit 44f4c6b
Show file tree

Hide file tree

Showing 18 changed files with 14 additions and 0 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -0,0 +1,3 @@
+# Go E2E Test Framework for Kubernetes
+
+[Design Document](design/README.md)
diff --git a/docs/custom-env-functions.md b/docs/custom-env-functions.md
@@ -0,0 +1 @@
+../examples/custom_env_funcs/README.md
diff --git a/docs/custom-flags.md b/docs/custom-flags.md
@@ -0,0 +1 @@
+../examples/custom_flags/README.md
diff --git a/docs/custom-resource-definitions-integration.md b/docs/custom-resource-definitions-integration.md
@@ -0,0 +1 @@
+../examples/crds/README.md
diff --git a/docs/design/test-harness-framework.md → docs/design/README.md b/docs/design/test-harness-framework.md → docs/design/README.md
diff --git a/docs/design/dry-run-mode.md → docs/dry-run-mode.md b/docs/design/dry-run-mode.md → docs/dry-run-mode.md
diff --git a/docs/exec-commands-in-pod.md b/docs/exec-commands-in-pod.md
@@ -0,0 +1 @@
+../examples/pod_exec/README.md
diff --git a/docs/design/fail-fast-mode.md → docs/fail-fast-mode.md b/docs/design/fail-fast-mode.md → docs/fail-fast-mode.md
diff --git a/docs/design/k8s-resource-watcher.md → docs/k8s-resource-watcher.md b/docs/design/k8s-resource-watcher.md → docs/k8s-resource-watcher.md
diff --git a/docs/design/klient-package.md → docs/klient-package.md b/docs/design/klient-package.md → docs/klient-package.md
diff --git a/docs/multi-cluster-tests.md b/docs/multi-cluster-tests.md
@@ -0,0 +1 @@
+../examples/multi_cluster/README.md
diff --git a/docs/parallel-test-runs.md b/docs/parallel-test-runs.md
@@ -0,0 +1 @@
+../examples/parallel_features/README.md
diff --git a/docs/real-cluster-integration.md b/docs/real-cluster-integration.md
@@ -0,0 +1 @@
+../examples/real_cluster/README.md
diff --git a/docs/design/resource-decoding.md → docs/resource-decoding.md b/docs/design/resource-decoding.md → docs/resource-decoding.md
diff --git a/docs/sonobuoy.md b/docs/sonobuoy.md
@@ -0,0 +1 @@
+../examples/sonobuoy/README.md
diff --git a/docs/third-party-integration.md b/docs/third-party-integration.md
@@ -0,0 +1 @@
+../examples/third_party_integration/README.md
diff --git a/docs/wait-for-resource.md b/docs/wait-for-resource.md
@@ -0,0 +1 @@
+../examples/wait_for_resources/README.md
diff --git a/docs/watch-resource.md b/docs/watch-resource.md
@@ -0,0 +1 @@
+../examples/watch_resources/README.md
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# Go E2E Test Framework for Kubernetes

		[Design Document](design/README.md)