diff --git a/_data/support.yml b/_data/support.yml index f2fcb546c1..9a1e4076b9 100644 --- a/_data/support.yml +++ b/_data/support.yml @@ -3,14 +3,6 @@ abstract: "Troubleshooting resources, frequently asked questions, and community toc: - docs/troubleshooting.md -- title: Troubleshooting - section: - - docs/user-guide/debugging-pods-and-replication-controllers.md - - docs/user-guide/introspection-and-debugging.md - - docs/user-guide/application-troubleshooting.md - - docs/admin/cluster-troubleshooting.md - - docs/user-guide/debugging-services.md - - title: Frequently Asked Questions section: - title: User FAQ @@ -23,12 +15,6 @@ toc: - title: Contributing to the Kubernetes Docs section: - editdocs.md - - docs/home/contribute/create-pull-request.md - - docs/home/contribute/write-new-topic.md - - docs/home/contribute/stage-documentation-changes.md - - docs/home/contribute/page-templates.md - - docs/home/contribute/review-issues.md - - docs/home/contribute/style-guide.md - title: Other Resources section: diff --git a/_data/tasks.yml b/_data/tasks.yml index 7b2b990674..ae329efac1 100644 --- a/_data/tasks.yml +++ b/_data/tasks.yml @@ -68,6 +68,7 @@ toc: - docs/tasks/debug-application-cluster/debug-cluster.md - docs/tasks/debug-application-cluster/debug-pod-replication-controller.md - docs/tasks/debug-application-cluster/debug-service.md + - docs/tasks/debug-application-cluster/troubleshooting.md - title: Accessing the Kubernetes API section: diff --git a/docs/tasks/debug-application-cluster/troubleshooting.md b/docs/tasks/debug-application-cluster/troubleshooting.md new file mode 100644 index 0000000000..49d9f3741b --- /dev/null +++ b/docs/tasks/debug-application-cluster/troubleshooting.md @@ -0,0 +1,86 @@ +--- +assignees: +- brendandburns +- davidopp +title: Troubleshooting +--- + +## Troubleshooting + +Sometimes things go wrong. This guide is aimed at making them right. It has +two sections: + + * [Troubleshooting your application](/docs/user-guide/application-troubleshooting) - Useful for users who are deploying code into Kubernetes and wondering why it is not working. + * [Troubleshooting your cluster](/docs/admin/cluster-troubleshooting) - Useful for cluster administrators and people whose Kubernetes cluster is unhappy. + +You should also check the known issues for the [release](https://github.com/kubernetes/kubernetes/releases) +you're using. + +### Getting help + +If your problem isn't answered by any of the guides above, there are variety of +ways for you to get help from the Kubernetes team. + +### Questions + +If you aren't familiar with it, many of your questions may be answered by the +[user guide](/docs/user-guide/). + +We also have a number of FAQ pages: + + * [User FAQ](https://github.com/kubernetes/kubernetes/wiki/User-FAQ) + * [Debugging FAQ](https://github.com/kubernetes/kubernetes/wiki/Debugging-FAQ) + * [Services FAQ](https://github.com/kubernetes/kubernetes/wiki/Services-FAQ) + +You may also find the Stack Overflow topics relevant: + + * [Kubernetes](http://stackoverflow.com/questions/tagged/kubernetes) + * [Google Container Engine - GKE](http://stackoverflow.com/questions/tagged/google-container-engine) + +## Help! My question isn't covered! I need help now! + +### Stack Overflow + +Someone else from the community may have already asked a similar question or may +be able to help with your problem. The Kubernetes team will also monitor +[posts tagged Kubernetes](http://stackoverflow.com/questions/tagged/kubernetes). +If there aren't any existing questions that help, please [ask a new one](http://stackoverflow.com/questions/ask?tags=kubernetes)! + +### Slack + +The Kubernetes team hangs out on Slack in the `#kubernetes-users` channel. You +can participate in discussion with the Kubernetes team [here](https://kubernetes.slack.com). +Slack requires registration, but the Kubernetes team is open invitation to +anyone to register [here](http://slack.kubernetes.io). Feel free to come and ask +any and all questions. + +Once registered, browse the growing list of channels for various subjects of +interest. For example, people new to Kubernetes may also want to join the +`#kubernetes-novice` channel. As another example, developers should join the +`#kubernetes-dev` channel. + +There are also many country specific/local language channels. Feel free to join +these channels for localized support and info: + +- France: `#fr-users`, `#fr-events` +- Germany: `#de-users`, `#de-events` +- Japan: `#jp-users`, `#jp-events` + +### Mailing List + +The Kubernetes / Google Container Engine mailing list is [kubernetes-users@googlegroups.com](https://groups.google.com/forum/#!forum/kubernetes-users) + +### Bugs and Feature requests + +If you have what looks like a bug, or you would like to make a feature request, +please use the [Github issue tracking system](https://github.com/kubernetes/kubernetes/issues). + +Before you file an issue, please search existing issues to see if your issue is +already covered. + +If filing a bug, please include detailed information about how to reproduce the +problem, such as: + +* Kubernetes version: `kubectl version` +* Cloud provider, OS distro, network configuration, and Docker version +* Steps to reproduce the problem diff --git a/docs/troubleshooting.md b/docs/troubleshooting.md index deb4375b85..8fc3a15492 100644 --- a/docs/troubleshooting.md +++ b/docs/troubleshooting.md @@ -5,82 +5,6 @@ assignees: title: Support --- -## Troubleshooting +{% include user-guide-content-moved.md %} -Sometimes things go wrong. This guide is aimed at making them right. It has -two sections: - - * [Troubleshooting your application](/docs/user-guide/application-troubleshooting) - Useful for users who are deploying code into Kubernetes and wondering why it is not working. - * [Troubleshooting your cluster](/docs/admin/cluster-troubleshooting) - Useful for cluster administrators and people whose Kubernetes cluster is unhappy. - -You should also check the known issues for the [release](https://github.com/kubernetes/kubernetes/releases) -you're using. - -### Getting help - -If your problem isn't answered by any of the guides above, there are variety of -ways for you to get help from the Kubernetes team. - -### Questions - -If you aren't familiar with it, many of your questions may be answered by the -[user guide](/docs/user-guide/). - -We also have a number of FAQ pages: - - * [User FAQ](https://github.com/kubernetes/kubernetes/wiki/User-FAQ) - * [Debugging FAQ](https://github.com/kubernetes/kubernetes/wiki/Debugging-FAQ) - * [Services FAQ](https://github.com/kubernetes/kubernetes/wiki/Services-FAQ) - -You may also find the Stack Overflow topics relevant: - - * [Kubernetes](http://stackoverflow.com/questions/tagged/kubernetes) - * [Google Container Engine - GKE](http://stackoverflow.com/questions/tagged/google-container-engine) - -## Help! My question isn't covered! I need help now! - -### Stack Overflow - -Someone else from the community may have already asked a similar question or may -be able to help with your problem. The Kubernetes team will also monitor -[posts tagged Kubernetes](http://stackoverflow.com/questions/tagged/kubernetes). -If there aren't any existing questions that help, please [ask a new one](http://stackoverflow.com/questions/ask?tags=kubernetes)! - -### Slack - -The Kubernetes team hangs out on Slack in the `#kubernetes-users` channel. You -can participate in discussion with the Kubernetes team [here](https://kubernetes.slack.com). -Slack requires registration, but the Kubernetes team is open invitation to -anyone to register [here](http://slack.kubernetes.io). Feel free to come and ask -any and all questions. - -Once registered, browse the growing list of channels for various subjects of -interest. For example, people new to Kubernetes may also want to join the -`#kubernetes-novice` channel. As another example, developers should join the -`#kubernetes-dev` channel. - -There are also many country specific/local language channels. Feel free to join -these channels for localized support and info: - -- France: `#fr-users`, `#fr-events` -- Germany: `#de-users`, `#de-events` -- Japan: `#jp-users`, `#jp-events` - -### Mailing List - -The Kubernetes / Google Container Engine mailing list is [kubernetes-users@googlegroups.com](https://groups.google.com/forum/#!forum/kubernetes-users) - -### Bugs and Feature requests - -If you have what looks like a bug, or you would like to make a feature request, -please use the [Github issue tracking system](https://github.com/kubernetes/kubernetes/issues). - -Before you file an issue, please search existing issues to see if your issue is -already covered. - -If filing a bug, please include detailed information about how to reproduce the -problem, such as: - -* Kubernetes version: `kubectl version` -* Cloud provider, OS distro, network configuration, and Docker version -* Steps to reproduce the problem +[Troubleshooting](/docs/tasks/debug-application-cluster/troubleshooting/) diff --git a/robots.txt b/robots.txt index 90d123bde7..420d8a5176 100644 --- a/robots.txt +++ b/robots.txt @@ -105,6 +105,19 @@ Disallow: /docs/admin/master-node-communication.html Disallow: /docs/admin/federation/kubefed.html Disallow: /docs/user-guide/federation/index.html +Disallow: /docs/user-guide/debugging-pods-and-replication-controllers.html +Disallow: /docs/user-guide/introspection-and-debugging.html +Disallow: /docs/user-guide/application-troubleshooting.html +Disallow: /docs/admin/cluster-troubleshooting.html +Disallow: /docs/user-guide/debugging-services.html +Disallow: /docs/contribute/create-pull-request.html +Disallow: /docs/contribute/write-new-topic.html +Disallow: /docs/contribute/stage-documentation-changes.html +Disallow: /docs/contribute/page-templates.html +Disallow: /docs/contribute/review-issues.html +Disallow: /docs/contribute/style-guide.html +Disallow: /docs/deprecation-policy.md + SITEMAP: http://kubernetes.io/sitemap.xml diff --git a/skip_toc_check.txt b/skip_toc_check.txt index 00fd00998b..d2697552e0 100644 --- a/skip_toc_check.txt +++ b/skip_toc_check.txt @@ -61,6 +61,7 @@ docs/user-guide/federation/replicasets.md docs/user-guide/federation/secrets.md docs/home/security.md +docs/deprecation-policy.md docs/home/deprecation-policy.md docs/whatisk8s.md @@ -101,5 +102,15 @@ docs/admin/master-node-communication.md docs/admin/federation/kubefed.md docs/user-guide/federation/index.md - +docs/user-guide/debugging-pods-and-replication-controllers.md +docs/user-guide/introspection-and-debugging.md +docs/user-guide/application-troubleshooting.md +docs/admin/cluster-troubleshooting.md +docs/user-guide/debugging-services.md +docs/contribute/create-pull-request.md +docs/contribute/write-new-topic.md +docs/contribute/stage-documentation-changes.md +docs/contribute/page-templates.md +docs/contribute/review-issues.md +docs/contribute/style-guide.md