From 02307da36d772610157e5c1ca52e597da4ac4999 Mon Sep 17 00:00:00 2001
From: Martin Hickey <martin.hickey@ie.ibm.com>
Date: Wed, 22 Apr 2020 15:35:29 +0000
Subject: [PATCH] Add improvement to docs

Some small improvements to docs of things I found while
using the docs.

Signed-off-by: Martin Hickey <martin.hickey@ie.ibm.com>
---
 README.md       | 11 ++++++-----
 docs/crictl.md  | 15 +++++++++++++++
 docs/testing.md |  1 +
 3 files changed, 22 insertions(+), 5 deletions(-)

diff --git a/README.md b/README.md
index 1c755c8b9..b663d6b2f 100644
--- a/README.md
+++ b/README.md
@@ -78,9 +78,10 @@ specifications as appropriate.
 backport version of `libseccomp-dev` is required. See [travis.yml](.travis.yml) for an example on trusty.
 * **btrfs development library.** Required by containerd btrfs support. `btrfs-tools`(Ubuntu, Debian) / `btrfs-progs-devel`(Fedora, CentOS, RHEL)
 2. Install **`socat`** (required by portforward).
-2. Install and setup a go 1.13.9 development environment. (Note: You can check the travis logs for a recent pull request to confirm the version(s) of golang currently being used to build and test master.)
-3. Make a local clone of this repository.
-4. Install binary dependencies by running the following command from your cloned `cri/` project directory:
+3. Install **`pkg-config`** (required for linking with `libseccomp`).
+4. Install and setup a Go 1.13.10 development environment.
+5. Make a local clone of this repository.
+6. Install binary dependencies by running the following command from your cloned `cri/` project directory:
 ```bash
 # Note: install.deps installs the above mentioned runc, containerd, and CNI
 # binary dependencies. install.deps is only provided for general use and ease of
@@ -114,7 +115,7 @@ make BUILD_TAGS='seccomp apparmor selinux'
 A Kubernetes incubator project called [cri-tools](https://github.com/kubernetes-sigs/cri-tools)
 includes programs for exercising CRI implementations such as the `cri` plugin.
 More importantly, cri-tools includes the program `critest` which is used for running
-[CRI Validation Testing](https://github.com/kubernetes/community/blob/master/contributors/devel/cri-validation.md).
+[CRI Validation Testing](https://github.com/kubernetes/community/blob/master/contributors/devel/sig-node/cri-validation.md).
 
 Run the CRI Validation test to validate your installation of `containerd` with `cri` built in:
 ```bash
@@ -140,7 +141,7 @@ See [here](./docs/crictl.md) for information about using `crictl` to debug
 pods, containers, and images.
 ## Configurations
 See [here](./docs/config.md) for information about how to configure cri plugins
-and [here](https://github.com/containerd/containerd/blob/master/docs/man/containerd-config.1.md)
+and [here](https://github.com/containerd/containerd/blob/master/docs/man/containerd-config.8.md)
 for information about how to configure containerd
 ## Documentation
 See [here](./docs) for additional documentation.
diff --git a/docs/crictl.md b/docs/crictl.md
index 2d82f831e..3a71575b5 100644
--- a/docs/crictl.md
+++ b/docs/crictl.md
@@ -38,6 +38,21 @@ $ crictl inspecti busybox
   ... displays information about the image.
 ```
 
+***Note:*** If you get an error similar to the following when running a `crictl`
+command (and your containerd instance is already running):
+```console
+crictl info
+FATA[0000] getting status of runtime failed: rpc error: code = Unimplemented desc = unknown service runtime.v1alpha2.RuntimeService
+```
+This could be that you are using an incorrect containerd configuration (maybe
+from a Docker install). You will need to update your containerd configuration
+to the containerd instance that you are running. One way of doing this is as
+follows:
+```console
+$ mv /etc/containerd/config.toml /etc/containerd/config.bak
+$ containerd config default > /etc/containerd/config.toml
+```
+
 ## Directly Load a Container Image
 Another way to load an image into the container runtime is with the load
 command. With the load command you inject a container image into the container
diff --git a/docs/testing.md b/docs/testing.md
index a85eb7834..4f387e2e8 100644
--- a/docs/testing.md
+++ b/docs/testing.md
@@ -9,6 +9,7 @@ Code verification includes lint, code formatting, boilerplate check etc.
 ```bash
 make install.tools
 ```
+***Note:*** Some make actions (like `install.tools`) use the user's `GOPATH` and will otherwise not work when it is not set. Other make actions override it by setting it to a temporary directory for release build and testing purposes.
 * Run code verification:
 ```bash
 make verify