| @@ -34,6 +34,8 @@ Library code that's safe to use by external applications (e.g., `/pkg/mypublicli | |||||
| Other projects will import these libraries expecting them to work, so think twice before you put something here :-) | Other projects will import these libraries expecting them to work, so think twice before you put something here :-) | ||||
| See the `/pkg` directory for examples. | |||||
| ### `/vendor` | ### `/vendor` | ||||
| Application dependencies (managed manually or by your favorite dependency management tool). | Application dependencies (managed manually or by your favorite dependency management tool). | ||||
| @@ -70,7 +72,9 @@ System init (systemd, upstart, sysv) and process manager/supervisor (runit, supe | |||||
| Scripts to perform various build, install, analysis, etc operations. | Scripts to perform various build, install, analysis, etc operations. | ||||
| These scripts keep the root level Makefile small and simple. | |||||
| These scripts keep the root level Makefile small and simple (e.g., `https://github.com/hashicorp/terraform/blob/master/Makefile`). | |||||
| See the `/scripts` directory for examples. | |||||
| ### `/build` | ### `/build` | ||||
| @@ -86,7 +90,7 @@ IaaS, PaaS, system and container orchestration deployment configurations and tem | |||||
| ### `/test` | ### `/test` | ||||
| Additional external test apps and test data. | |||||
| Additional external test apps and test data. Feel free to structure the `/test` directory anyway you want. For bigger projects it makes sense to have a data subdirectory (e.g., `/test/data`). | |||||
| See the `/test` directory for examples. | See the `/test` directory for examples. | ||||
| @@ -4,4 +4,5 @@ OpenAPI/Swagger specs, JSON schema files, protocol definition files. | |||||
| Examples: | Examples: | ||||
| * https://github.com/kubernetes/kubernetes/tree/master/api | |||||
| * https://github.com/openshift/origin/tree/master/api | * https://github.com/openshift/origin/tree/master/api | ||||
| @@ -5,3 +5,7 @@ Packaging and Continous Integration. | |||||
| Put your cloud (AMI), container (Docker), OS (deb, rpm, pkg) package configurations and scripts in the `/build/package` directory. | Put your cloud (AMI), container (Docker), OS (deb, rpm, pkg) package configurations and scripts in the `/build/package` directory. | ||||
| Put your CI (travis, circle, drone) configurations and scripts in the `/build/ci` directory. | Put your CI (travis, circle, drone) configurations and scripts in the `/build/ci` directory. | ||||
| Examples: | |||||
| * https://github.com/cockroachdb/cockroach/tree/master/build | |||||
| @@ -10,4 +10,9 @@ It's common to have a small `main` function that imports and invokes the code fr | |||||
| Examples: | Examples: | ||||
| * https://github.com/heptio/ark/tree/master/cmd | |||||
| * https://github.com/heptio/ark/tree/master/cmd (just a really small `main` function with everything else in packages) | |||||
| * https://github.com/moby/moby/tree/master/cmd | |||||
| * https://github.com/prometheus/prometheus/tree/master/cmd | |||||
| * https://github.com/influxdata/influxdb/tree/master/cmd | |||||
| * https://github.com/kubernetes/kubernetes/tree/master/cmd | |||||
| @@ -4,4 +4,5 @@ Design and user documents (in addition to your godoc generated documentation). | |||||
| Examples: | Examples: | ||||
| * https://github.com/gohugoio/hugo/tree/master/docs | |||||
| * https://github.com/openshift/origin/tree/master/docs | * https://github.com/openshift/origin/tree/master/docs | ||||
| @@ -4,4 +4,7 @@ Examples for your applications and/or public libraries. | |||||
| Examples: | Examples: | ||||
| * https://github.com/nats-io/go-nats/tree/master/examples | |||||
| * https://github.com/docker-slim/docker-slim/tree/master/examples | * https://github.com/docker-slim/docker-slim/tree/master/examples | ||||
| * https://github.com/gohugoio/hugo/tree/master/examples | |||||
| * https://github.com/hashicorp/packer/tree/master/examples | |||||
| @@ -3,3 +3,11 @@ | |||||
| Library code that's safe to use by external applications (e.g., `/pkg/mypubliclib`). | Library code that's safe to use by external applications (e.g., `/pkg/mypubliclib`). | ||||
| Other projects will import these libraries expecting them to work, so think twice before you put something here :-) | Other projects will import these libraries expecting them to work, so think twice before you put something here :-) | ||||
| Examples: | |||||
| * https://github.com/kubernetes/kubernetes/tree/master/pkg | |||||
| * https://github.com/moby/moby/tree/master/pkg | |||||
| * https://github.com/grafana/grafana/tree/master/pkg | |||||
| * https://github.com/influxdata/influxdb/tree/master/pkg | |||||
| * https://github.com/coreos/etcd/tree/master/pkg | |||||
| @@ -3,3 +3,9 @@ | |||||
| Scripts to perform various build, install, analysis, etc operations. | Scripts to perform various build, install, analysis, etc operations. | ||||
| These scripts keep the root level Makefile small and simple. | These scripts keep the root level Makefile small and simple. | ||||
| Examples: | |||||
| * https://github.com/kubernetes/helm/tree/master/scripts | |||||
| * https://github.com/cockroachdb/cockroach/tree/master/scripts | |||||
| * https://github.com/hashicorp/terraform/tree/master/scripts | |||||
| @@ -1,6 +1,6 @@ | |||||
| # `/test` | # `/test` | ||||
| Additional external test apps and test data. | |||||
| Additional external test apps and test data. Feel free to structure the `/test` directory anyway you want. For bigger projects it makes sense to have a data subdirectory (e.g., `/test/data`). | |||||
| Examples: | Examples: | ||||
| @@ -4,4 +4,5 @@ Supporting tools for this project. Note that these tools can import code from th | |||||
| Examples: | Examples: | ||||
| * https://github.com/istio/istio/tree/master/tools | |||||
| * https://github.com/openshift/origin/tree/master/tools | * https://github.com/openshift/origin/tree/master/tools | ||||