From dbef1f8bce839dbe13778561bcaf68c34cfca9a7 Mon Sep 17 00:00:00 2001 From: Jimmy Zelinskie Date: Tue, 23 Aug 2016 17:11:30 -0400 Subject: [PATCH 1/2] docs: move to standard Documentation dir --- api/v1/README.md => Documentation/api_v1.md | 0 notifier/README.md => Documentation/notifications.md | 0 2 files changed, 0 insertions(+), 0 deletions(-) rename api/v1/README.md => Documentation/api_v1.md (100%) rename notifier/README.md => Documentation/notifications.md (100%) diff --git a/api/v1/README.md b/Documentation/api_v1.md similarity index 100% rename from api/v1/README.md rename to Documentation/api_v1.md diff --git a/notifier/README.md b/Documentation/notifications.md similarity index 100% rename from notifier/README.md rename to Documentation/notifications.md From cb5ba4debf16d3c3b5f0aa54e8d15ab26a957f4d Mon Sep 17 00:00:00 2001 From: Jimmy Zelinskie Date: Wed, 24 Aug 2016 11:19:52 -0400 Subject: [PATCH 2/2] readme: link docs to coreos.com --- README.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 54078d929b..3f3c0932ca 100644 --- a/README.md +++ b/README.md @@ -119,10 +119,9 @@ $ ./$GOBIN/clair -config=config.yaml ## Documentation -Documentation can be found in a `README.md` file located in the directory of the component. +The latest stable documentation can be found [on the CoreOS website] or inside the Documentation directory at the root of the project's source code. -- [Notifier](https://github.com/coreos/clair/blob/master/notifier/README.md) -- [v1 API](https://github.com/coreos/clair/blob/master/api/v1/README.md) +[on the CoreOS website]: https://coreos.com/clair/docs/latest/ ### Architecture at a Glance