Skip to content

Commit e82886e

Browse files
committed
more references
1 parent 55ba244 commit e82886e

File tree

10 files changed

+37
-4
lines changed

10 files changed

+37
-4
lines changed

README.md

+6-2
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,8 @@ Library code that's safe to use by external applications (e.g., `/pkg/mypublicli
3434

3535
Other projects will import these libraries expecting them to work, so think twice before you put something here :-)
3636

37+
See the `/pkg` directory for examples.
38+
3739
### `/vendor`
3840

3941
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
7072

7173
Scripts to perform various build, install, analysis, etc operations.
7274

73-
These scripts keep the root level Makefile small and simple.
75+
These scripts keep the root level Makefile small and simple (e.g., `https://github.com/hashicorp/terraform/blob/master/Makefile`).
76+
77+
See the `/scripts` directory for examples.
7478

7579
### `/build`
7680

@@ -86,7 +90,7 @@ IaaS, PaaS, system and container orchestration deployment configurations and tem
8690

8791
### `/test`
8892

89-
Additional external test apps and test data.
93+
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`).
9094

9195
See the `/test` directory for examples.
9296

api/README.md

+1
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,5 @@ OpenAPI/Swagger specs, JSON schema files, protocol definition files.
44

55
Examples:
66

7+
* https://github.com/kubernetes/kubernetes/tree/master/api
78
* https://github.com/openshift/origin/tree/master/api

build/README.md

+4
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,7 @@ Packaging and Continous Integration.
55
Put your cloud (AMI), container (Docker), OS (deb, rpm, pkg) package configurations and scripts in the `/build/package` directory.
66

77
Put your CI (travis, circle, drone) configurations and scripts in the `/build/ci` directory.
8+
9+
Examples:
10+
11+
* https://github.com/cockroachdb/cockroach/tree/master/build

cmd/README.md

+6-1
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,9 @@ It's common to have a small `main` function that imports and invokes the code fr
1010

1111
Examples:
1212

13-
* https://github.com/heptio/ark/tree/master/cmd
13+
* https://github.com/heptio/ark/tree/master/cmd (just a really small `main` function with everything else in packages)
14+
* https://github.com/moby/moby/tree/master/cmd
15+
* https://github.com/prometheus/prometheus/tree/master/cmd
16+
* https://github.com/influxdata/influxdb/tree/master/cmd
17+
* https://github.com/kubernetes/kubernetes/tree/master/cmd
18+

docs/README.md

+1
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,5 @@ Design and user documents (in addition to your godoc generated documentation).
44

55
Examples:
66

7+
* https://github.com/gohugoio/hugo/tree/master/docs
78
* https://github.com/openshift/origin/tree/master/docs

examples/README.md

+3
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,7 @@ Examples for your applications and/or public libraries.
44

55
Examples:
66

7+
* https://github.com/nats-io/go-nats/tree/master/examples
78
* https://github.com/docker-slim/docker-slim/tree/master/examples
9+
* https://github.com/gohugoio/hugo/tree/master/examples
10+
* https://github.com/hashicorp/packer/tree/master/examples

pkg/README.md

+8
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,11 @@
33
Library code that's safe to use by external applications (e.g., `/pkg/mypubliclib`).
44

55
Other projects will import these libraries expecting them to work, so think twice before you put something here :-)
6+
7+
Examples:
8+
9+
* https://github.com/kubernetes/kubernetes/tree/master/pkg
10+
* https://github.com/moby/moby/tree/master/pkg
11+
* https://github.com/grafana/grafana/tree/master/pkg
12+
* https://github.com/influxdata/influxdb/tree/master/pkg
13+
* https://github.com/coreos/etcd/tree/master/pkg

scripts/README.md

+6
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,9 @@
33
Scripts to perform various build, install, analysis, etc operations.
44

55
These scripts keep the root level Makefile small and simple.
6+
7+
Examples:
8+
9+
* https://github.com/kubernetes/helm/tree/master/scripts
10+
* https://github.com/cockroachdb/cockroach/tree/master/scripts
11+
* https://github.com/hashicorp/terraform/tree/master/scripts

test/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# `/test`
22

3-
Additional external test apps and test data.
3+
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`).
44

55
Examples:
66

tools/README.md

+1
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,5 @@ Supporting tools for this project. Note that these tools can import code from th
44

55
Examples:
66

7+
* https://github.com/istio/istio/tree/master/tools
78
* https://github.com/openshift/origin/tree/master/tools

0 commit comments

Comments
 (0)