Merge pull request #3310 from superseb/update_docs

update README and add troubleshooting doc links

README-template.md

@@ -12,56 +12,52 @@ Please check the [releases](https://github.com/rancher/rke/releases/) page.
 
 ## Requirements
 
-Please review the [OS requirements](https://rancher.com/docs/rke/latest/en/os/) for each node in your Kubernetes cluster.
+Please review the [Requirements](https://rke.docs.rancher.com/os) for each node in your Kubernetes cluster.
 
 ## Getting Started
 
-Please refer to our [RKE docs](https://rancher.com/docs/rke/latest/en/) for information on how to get started!
-For cluster config examples, refer to [RKE cluster.yml examples](https://rancher.com/docs/rke/latest/en/example-yamls/)
+Please refer to our [RKE docs](https://rke.docs.rancher.com/) for information on how to get started!
+For cluster config examples, refer to [RKE cluster.yml examples](https://rke.docs.rancher.com/example-yamls)
 
 ## Installing Rancher HA using rke
 
-Please use [High Availability (HA) Install](https://rancher.com/docs/rancher/v2.x/en/installation/ha/) to install Rancher in a high-availability configuration.
+Please use [Setting up a High-availability RKE Kubernetes Cluster](https://ranchermanager.docs.rancher.com/how-to-guides/new-user-guides/kubernetes-cluster-setup/rke1-for-rancher) to install Rancher in a high-availability configuration.
 
 ## Building
 
 RKE can be built using the `make` command, and will use the scripts in the `scripts` directory as subcommands. The default subcommand is `ci` and will use `scripts/ci`. Cross compiling can be enabled by setting the environment variable `CROSS=1`. The compiled binaries can be found in the `build/bin` directory. Dependencies are managed by Go modules and can be found in [go.mod](https://github.com/rancher/rke/blob/master/go.mod).
 
-RKE now fetches `data.json` from https://github.com/rancher/kontainer-driver-metadata. To fetch data.json and compile it in rke, run 
+Read [codegen/codegen.go](./codegen/codegen.go) to check the default location for fetching `data.json`. You can override the default location as seen in the example below:
 
 ```bash
+# Fetch data.json from default location
 go generate
 
-# Change RANCHER_METADATA_URL to an external URL instead of using https://releases.rancher.com/kontainer-driver-metadata/dev-v2.6/data.json by default
+# Fetch data.json from URL using RANCHER_METADATA_URL
 RANCHER_METADATA_URL=${URL} go generate
 
-# Or load it from local file
+# Use data.json from local file
 RANCHER_METATDATA_URL=./local/data.json go generate
 
 # Compile RKE
 make
 ```
 
-To specify RANCHER_METADATA_URL in runtime, populate the environment variable when running rke CLI. For example:
+To override RANCHER_METADATA_URL at runtime, populate the environment variable when running rke CLI. For example:
 
 ```bash
 RANCHER_METADATA_URL=${URL} rke [commands] [options]
 
 RANCHER_METADATA_URL=${./local/data.json} rke [commands] [options]
 ```
 
-`RANCHER_METADATA_URL` defaults to `https://releases.rancher.com/kontainer-driver-metadata/dev-v2.6/data.json`.
-
 ## License
 
-Copyright (c) CURRENTYEAR [Rancher Labs, Inc.](http://rancher.com)
-
+Copyright © 2017 - CURRENTYEAR SUSE LLC
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
 You may obtain a copy of the License at
-
-[http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)
-
+    http://www.apache.org/licenses/LICENSE-2.0
 Unless required by applicable law or agreed to in writing, software
 distributed under the License is distributed on an "AS IS" BASIS,
 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

docs/troubleshooting.md

@@ -0,0 +1,4 @@
+# Troubleshooting
+
+* [RKE docs: Troubleshooting](https://rke.docs.rancher.com/troubleshooting)
+* [Rancher docs: General Troubleshooting](https://ranchermanager.docs.rancher.com/troubleshooting/general-troubleshooting)