deploytool: Add README.md, migrate docs to it.

deploytool/api/deploy/config.pb.go

 // Code generated by protoc-gen-go.
 // source: github.com/luci/luci-go/deploytool/api/deploy/config.proto
 // DO NOT EDIT!
 
 package deploy
 
 import proto "github.com/golang/protobuf/proto"
 import fmt "fmt"
 import math "math"
 
@@ skipping 18 matching lines @@
 }
 
 func (x Deployment_CloudProject_VersionScheme) String() string {
         return proto.EnumName(Deployment_CloudProject_VersionScheme_name, int32(x))
 }
 func (Deployment_CloudProject_VersionScheme) EnumDescriptor() ([]byte, []int) {
         return fileDescriptor2, []int{3, 0, 0}
 }
 
 // *
-// The deployment configuration is a set of parameters composed from local and
-// source configuration files. Each configuration file is read as a text
-// protobuf in two stages:
+// Layout defines the root directory of a deployment configuration.
 //
-// Local Stage
-// ============
-// First, the source and project layout configurations are loaded. These detail
-// the projects that are to be deployed and the source definitions for those
-// projects.
-//
-// Local configurations are located in subdirectories relative to a root
-// "layout.cfg" file:
-//
-// /layout.cfg
-// /sources/
-//   <source-group-name>/     (Defines a source group).
-//     <source-name>.cfg      (Defines a source within the source group).
-//
-// /applications/
-//   <application-name>.cfg   (Defines a application).
-//
-// /deployments/
-//   <deployment-name>.cfg    (Defines a deployment).
-//
-// Each "source" defines host repositories to check out with that source's name.
-// Sources can be pulled from a variety of places, and will be checked out into
-// uniquely-named staging directories.
-//
-// Each "application" defines a set of source-relative components that the
-// application is composed of. The components' definitions are located in the
-// deployment configuration area within their source.
-//
-// A "deployment" binds an "application" to a set of "sources" and
-// deployment-specific parameters (e.g., cloud project). A deployment's
-// configuration is composed of its application's components loaded from their
-// sources. Deployment operations are executed against deployments.
-//
-// Source Stage
-// ============
-// Each source referenced by the named application(s) will be checked out in a
-// staging area. Configurations referenced by the applications will then be
-// loaded from those sources to complete the deployment configuration.
+// Each layout field has a default value, so an empty layout protobuf file is
+// a valid layout. Each field may be overridden to suit your repository's
+// structure, if needed.
 type Layout struct {
         // *
         // If specified, the relative path to the sources configuration directory. If
         // empty, this will default to "sources".
         SourcesPath string `protobuf:"bytes,1,opt,name=sources_path,json=sourcesPath" json:"sources_path,omitempty"`
         // *
         // If specified, the relative path to the applications configuration
         // directory. If empty, this will default to "applications".
         ApplicationsPath string `protobuf:"bytes,2,opt,name=applications_path,json=applicationsPath" json:"applications_path,omitempty"`
         // *
@@ skipping 13 matching lines @@
 // *
 // Source represents a single source configuration file.
 //
 // It contains definitions for the set of source repositories that make up this
 // Source.
 //
 // Each source is defined within a source group directory, and is named
 // "<source-name>.cfg". The source can be referenced internally by its full
 // source path, "<source-group-name>/<source-name>".
 //
-// If the source root contains a ".luci-deploytool.cfg" file, it will be read
+// If the source root contains a "luci-deploy.cfg" file, it will be read
 // and interepreted as a "SourceLayout" message.
 type Source struct {
         // Types that are valid to be assigned to Source:
         //      *Source_Git
         Source isSource_Source `protobuf_oneof:"source"`
         // *
         // Go Paths to add to this repository.
         //
         // This will be prepended to the GOPATH that the repository exports during its
         // configuration/initialization.
         GoPath []*GoPath `protobuf:"bytes,10,rep,name=go_path,json=goPath" json:"go_path,omitempty"`
         // *
         // If true, this repository is allowed to run scripts:
         // - At source initialization time, the initialization scripts defined in
-        //   ".luci-deploytool.cfg" will be executed.
+        //   "/luci-deploy.cfg" will be executed.
         // - At build time, build scripts associated with a Component will
         //   be executed. Note that if the a Component declares a build script and `run_scripts` is not true,
         //   the build will fail.
         //
         // It is important that this repository is trusted if this is set to true,
         // since this script will be run on the deployment system under the
         // deployment user account.
         RunScripts bool `protobuf:"varint,11,opt,name=run_scripts,json=runScripts" json:"run_scripts,omitempty"`
         // * If true, mark this as a tained source.
         Tainted bool `protobuf:"varint,12,opt,name=tainted" json:"tainted,omitempty"`
@@ skipping 368 matching lines @@
         0xc2, 0x24, 0xf9, 0x11, 0x24, 0x36, 0x13, 0xd0, 0x64, 0x2e, 0xd3, 0xb8, 0xf2, 0xfc, 0x45, 0x94,
         0x10, 0x97, 0xaf, 0x53, 0x52, 0x3c, 0x28, 0x06, 0xbb, 0x13, 0x10, 0x9a, 0x40, 0x23, 0xa5, 0x81,
         0x79, 0x15, 0xfe, 0xfc, 0x76, 0x47, 0x9c, 0x29, 0x0d, 0x2e, 0xa2, 0x24, 0x10, 0x0f, 0x13, 0x96,
         0x0a, 0xf6, 0x19, 0x40, 0x09, 0x6d, 0x3c, 0x99, 0x0d, 0x3b, 0x8c, 0xa8, 0x94, 0x67, 0xea, 0x74,
         0x4d, 0xfc, 0x54, 0x0f, 0x7f, 0x86, 0xdd, 0x67, 0x81, 0x40, 0x16, 0xb4, 0xaf, 0xae, 0xff, 0x3b,
         0x7f, 0x7d, 0x7b, 0xd7, 0xdf, 0x12, 0xda, 0xbd, 0xe7, 0x31, 0x95, 0xef, 0xc9, 0x92, 0xac, 0x8b,
         0x17, 0x46, 0x2c, 0xa5, 0x47, 0x0f, 0x5e, 0x9c, 0x17, 0xc6, 0xe9, 0xe2, 0xb4, 0xfe, 0x57, 0x6d,
         0xde, 0x52, 0x6f, 0xfc, 0x1f, 0x5f, 0x03, 0x00, 0x00, 0xff, 0xff, 0x57, 0xc3, 0x08, 0xf0, 0x67,
         0x06, 0x00, 0x00,
 }