Merge pull request #558 from rramkumar1/init-contrib-docs

Initialize directories which will house our updated documentation.
kubernetes · Dec 10, 2018 · 9632453 · 9632453
2 parents f19d9f3 + b8412f7
commit 9632453
Show file tree

Hide file tree

Showing 7 changed files with 23 additions and 0 deletions.
diff --git a/docs/concepts/README.md b/docs/concepts/README.md
@@ -0,0 +1,4 @@
+# Concepts
+
+This directory will soon contain up-to-date information on how the ingress-gce
+internally works. 
diff --git a/docs/contrib/README.md b/docs/contrib/README.md
@@ -0,0 +1,4 @@
+# Contribute
+
+This directory will soon contain up-to-date information on how to contribute to
+ingress-gce
diff --git a/docs/deploy/README.md b/docs/deploy/README.md
@@ -0,0 +1,5 @@
+# How To Run
+
+This directory will soon contain up-to-date information on how to run your own
+self-managed instance of the ingress-gce controller.
+
diff --git a/docs/dev/README.md b/docs/dev/README.md
@@ -1,5 +1,8 @@
 # Ingress Development Guide
 
+*** Note: This directory will soon be completely removed in favor of docs/contrib and
+docs/deploy. ***
+
 This directory is intended to be the canonical source of truth for things like
 writing and hacking on Ingress controllers. If you find a requirement that this
 doc does not capture, please submit an issue on GitHub. If you find other docs

diff --git a/docs/testing.md → docs/dev/testing.md b/docs/testing.md → docs/dev/testing.md
diff --git a/docs/troubleshooting/README.md b/docs/troubleshooting/README.md
@@ -0,0 +1,7 @@
+# Troubleshooting
+
+This directory will soon contain up-to-date information on troubleshooting tips
+for ingress-gce
+
+*** Note: Any existing documentation in this directory is considered legacy. It
+will be updated soon. ***
diff --git a/docs/troubleshooting.md → docs/troubleshooting/troubleshooting.md b/docs/troubleshooting.md → docs/troubleshooting/troubleshooting.md