API package godocs that summarize and favor the v1 API over v0

api/doc.go

@@ -0,0 +1,15 @@
+// Package api presents two independently developed and maintained Mesos API implementations.
+// Clients should not consume this package directly.
+//
+// v0
+//
+// The "v0" subpackage has been tested for compatibility with the Mesos v0.2x release series and
+// utilizes the "unversioned" or "v0" libprocess-based API presented by Mesos. Support for the v0
+// API is on life-support and only critical bug fixes may be addressed. All current and future
+// development effort focuses on the v1 Mesos API.
+//
+// v1
+//
+// The "v1" subpackage is compatible with the Mesos v1.x release series and utilizes the v1 HTTP
+// API presented by Mesos. This is the recommended library to use for Mesos framework development.
+package api

api/v1/doc.go

@@ -0,0 +1,14 @@
+// Package v1 contains library and example subpackages for working with the Mesos v1 HTTP API.
+// Clients should not consume this package directly.
+//
+// Library
+//
+// The v1 API is accessible via the "lib" subpackage. Consumers should import
+// "github.com/mesos/mesos-go/api/v1/lib" and refer to its funcs and types via the "mesos" package,
+// for example `mesos.Resource`.
+//
+// Examples
+//
+// See subpackage "cmd" for sample frameworks.
+// See directory "docker" for an illustration of framework deployment via Docker and Marathon.
+package v1

api/v1/lib/doc.go

@@ -0,0 +1,3 @@
+// Package mesos presents common v1 HTTP API message types in addition to extension APIs that
+// aim to simplify use of the machine-generated code.
+package mesos