From 121c4a2f8035b2e36d49a79259e2c94d7492272f Mon Sep 17 00:00:00 2001 From: Amy Lindburg Date: Wed, 18 Mar 2015 18:57:20 -0700 Subject: [PATCH 1/2] recast text of the page --- ROADMAP.md | 85 +++++++++++++++++++++++++----------------------------- 1 file changed, 39 insertions(+), 46 deletions(-) diff --git a/ROADMAP.md b/ROADMAP.md index 51a10a6a3..be3022720 100644 --- a/ROADMAP.md +++ b/ROADMAP.md @@ -1,10 +1,12 @@ # Roadmap -This document covers the high-level the goals and dates for features in the -docker registry. The distribution project currently has several components to -report in the road map, which are covered below. +The Distribution Project consists of several components, some of which are still being defined. This document defines the high-level goals of the project, identifies the current components, and defines the release-relationship to the Docker Platform. -## Goals +* [Distribution Goals](#distribution-goals) +* [Distribution Components](#distribution-components) +* [Project Planning](#project-planning): release-relationship to the Docker Platform. + +## Distribution Goals - Replace the existing [docker registry](github.com/docker/docker-registry) implementation as the primary implementation. @@ -13,30 +15,27 @@ report in the road map, which are covered below. - Define a strong data model for distributing docker images - Provide a flexible distribution tool kit for use in the docker platform -## Components +## Distribution Components -The distribution project has a few components with independent road maps and -road maps related to the docker project. They are covered below. +Components of the Distribution Project are managed via github [milestones](https://github.com/docker/distribution/milestones). Upcoming +features and bugfixes for a component will be added to the relevant milestone. If a feature or +bugfix is not part of a milestone, it is currently unscheduled for +implementation. + +* [Registry](#registry) +* [Distribution Package](#distribution-package) + +*** ### Registry -The current status of the registry road map is managed via github -[milestones](https://github.com/docker/distribution/milestones). Upcoming -features and bugfixes will be added to relevant milestones. If a feature or -bugfix is not part of a milestone, it is currently unscheduled for -implementation. - -The high-level goals for each registry release are part of this section. - -#### 2.0 - -Milestones: [2.0.0-beta](https://github.com/docker/distribution/milestones/Registry/2.0.0-beta) [2.0.0-rc](https://github.com/docker/distribution/milestones/Registry/2.0.0-rc) [2.0.0](https://github.com/docker/distribution/milestones/Registry/2.0.0) - -The 2.0 release is the first release of the new registry. This is mostly +Registry 2.0 is the first release of the next-generation registry. This is primarily focused on implementing the [new registry -API](https://github.com/docker/distribution/blob/master/doc/spec/api.md) with +API](https://github.com/docker/distribution/blob/master/doc/spec/api.md), with a focus on security and performance. +#### Registry 2.0 + Features: - Faster push and pull @@ -50,9 +49,7 @@ Features: - Pluggable authentication system - Health Checks ([#230](https://github.com/docker/distribution/pull/230)) -#### 2.1 - -Milestone: [2.1](https://github.com/docker/distribution/milestones/Registry/2.1) +#### Registry 2.1 Planned Features: @@ -62,33 +59,29 @@ Planned Features: - Mirroring ([#19](https://github.com/docker/distribution/issues/19)) - Flexible client package based on distribution interfaces ([#193](https://github.com/docker/distribution/issues/193) -#### 2.2 - -Milestone: [2.2](https://github.com/docker/distribution/milestones/Registry/2.2) +#### Registry 2.2 TBD -### Docker Platform +### Distribution Package -To track various requirements that must be synced with releases of the docker -platform, we've defined labels corresponding to upcoming releases. Each -release also has a project page explaining the relationship of the -distribution project with the docker project. +At its core, the Distribution Project is a set of Go packages that make up +Distribution Components. At this time, most of these packages make up the +Registry implementation. -Please see the following table for more information: +The package itself is considered unstable. If you're using it, please take care to vendor the dependent version. -| Platform Version | Milestone | Project | +For feature additions, please see the Registry section. In the future, we may break out a +separate Roadmap for distribution-specific features that apply to more than +just the registry. + +### Project Planning + +Distribution Components map to Docker Platform Releases via the use of labels. Project Pages are used to define the set of features that are included in each Docker Platform Release. + +| Platform Version | Label | Planning | |-----------|------|-----| -| Docker 1.6 | [Docker/1.6](https://github.com/docker/distribution/labels/docker%2F1.6) | [Project](https://github.com/docker/distribution/wiki/docker-1.6-Project-Page) | -| Docker 1.7| [Docker/1.7](https://github.com/docker/distribution/labels/docker%2F1.7) | [Project](https://github.com/docker/distribution/wiki/docker-1.7-Project-Page) | -| Docker 1.8| [Docker/1.8](https://github.com/docker/distribution/labels/docker%2F1.8) | [Project](https://github.com/docker/distribution/wiki/docker-1.8-Project-Page) | +| Docker 1.6 | [Docker/1.6](https://github.com/docker/distribution/labels/docker%2F1.6) | [Project Page](https://github.com/docker/distribution/wiki/docker-1.6-Project-Page) | +| Docker 1.7| [Docker/1.7](https://github.com/docker/distribution/labels/docker%2F1.7) | [Project Page](https://github.com/docker/distribution/wiki/docker-1.7-Project-Page) | +| Docker 1.8| [Docker/1.8](https://github.com/docker/distribution/labels/docker%2F1.8) | [Project Page](https://github.com/docker/distribution/wiki/docker-1.8-Project-Page) | -### Package - -The distribution project, at its core, is a set of Go packages that make up -distribution components. At this time, most of these packages make up the -registry implementation. The package itself is considered unstable. If you're -using it, please take care to vendor the dependent version. For feature -additions, please see the Registry section. In the future, we may break out a -separate road map for distribution specific features that apply to more than -just the registry. \ No newline at end of file From 028fece85c472ab7633455a72ad2a43a61aa42a3 Mon Sep 17 00:00:00 2001 From: Amy Lindburg Date: Wed, 18 Mar 2015 19:02:37 -0700 Subject: [PATCH 2/2] more formatting... --- ROADMAP.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/ROADMAP.md b/ROADMAP.md index be3022720..fddc71b35 100644 --- a/ROADMAP.md +++ b/ROADMAP.md @@ -63,6 +63,8 @@ Planned Features: TBD +*** + ### Distribution Package At its core, the Distribution Project is a set of Go packages that make up @@ -75,6 +77,8 @@ For feature additions, please see the Registry section. In the future, we may br separate Roadmap for distribution-specific features that apply to more than just the registry. +*** + ### Project Planning Distribution Components map to Docker Platform Releases via the use of labels. Project Pages are used to define the set of features that are included in each Docker Platform Release.