diff --git a/README.md b/README.md index 8a0c119..e29809d 100644 --- a/README.md +++ b/README.md @@ -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 :-) +See the `/pkg` directory for examples. + ### `/vendor` 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. -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` @@ -86,7 +90,7 @@ IaaS, PaaS, system and container orchestration deployment configurations and tem ### `/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. diff --git a/api/README.md b/api/README.md index c97c0a4..c9c9f38 100644 --- a/api/README.md +++ b/api/README.md @@ -4,4 +4,5 @@ OpenAPI/Swagger specs, JSON schema files, protocol definition files. Examples: +* https://github.com/kubernetes/kubernetes/tree/master/api * https://github.com/openshift/origin/tree/master/api diff --git a/build/README.md b/build/README.md index 91ce6ac..37c128c 100644 --- a/build/README.md +++ b/build/README.md @@ -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 CI (travis, circle, drone) configurations and scripts in the `/build/ci` directory. + +Examples: + +* https://github.com/cockroachdb/cockroach/tree/master/build diff --git a/cmd/README.md b/cmd/README.md index f7c6e83..bdb5e68 100644 --- a/cmd/README.md +++ b/cmd/README.md @@ -10,4 +10,9 @@ It's common to have a small `main` function that imports and invokes the code fr 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 + diff --git a/docs/README.md b/docs/README.md index a97147d..21f97ee 100644 --- a/docs/README.md +++ b/docs/README.md @@ -4,4 +4,5 @@ Design and user documents (in addition to your godoc generated documentation). Examples: +* https://github.com/gohugoio/hugo/tree/master/docs * https://github.com/openshift/origin/tree/master/docs diff --git a/examples/README.md b/examples/README.md index 10aa073..aece0bf 100644 --- a/examples/README.md +++ b/examples/README.md @@ -4,4 +4,7 @@ Examples for your applications and/or public libraries. Examples: +* https://github.com/nats-io/go-nats/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 diff --git a/pkg/README.md b/pkg/README.md index 942404c..2335735 100644 --- a/pkg/README.md +++ b/pkg/README.md @@ -3,3 +3,11 @@ 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 :-) + +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 diff --git a/scripts/README.md b/scripts/README.md index 3690150..edb724e 100644 --- a/scripts/README.md +++ b/scripts/README.md @@ -3,3 +3,9 @@ Scripts to perform various build, install, analysis, etc operations. 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 \ No newline at end of file diff --git a/test/README.md b/test/README.md index 61843dd..281f94e 100644 --- a/test/README.md +++ b/test/README.md @@ -1,6 +1,6 @@ # `/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: diff --git a/tools/README.md b/tools/README.md index f0e78ec..e5be7c7 100644 --- a/tools/README.md +++ b/tools/README.md @@ -4,4 +4,5 @@ Supporting tools for this project. Note that these tools can import code from th Examples: +* https://github.com/istio/istio/tree/master/tools * https://github.com/openshift/origin/tree/master/tools