From 55ba244c26e40fa1cd0b7697a3fb2e010727ad23 Mon Sep 17 00:00:00 2001 From: Kyle Quest Date: Sat, 28 Apr 2018 22:33:08 -0700 Subject: [PATCH] adding layout references --- README.md | 12 ++++++++++++ api/README.md | 4 ++++ cmd/README.md | 4 ++++ docs/README.md | 4 ++++ examples/README.md | 4 ++++ test/README.md | 6 ++++++ tools/README.md | 4 ++++ 7 files changed, 38 insertions(+) diff --git a/README.md b/README.md index e39983f..8a0c119 100644 --- a/README.md +++ b/README.md @@ -20,6 +20,8 @@ Don't put a lot of code in the application directory. If you think the code can It's common to have a small `main` function that imports and invokes the code from the `/internal` and `/pkg` directories and nothing else. +See the `/cmd` directory for examples. + ### `/internal` Private application and library code. This is the code you don't want others importing in their applications or libraries. @@ -44,6 +46,8 @@ Don't commit your application dependencies if you are building a library. OpenAPI/Swagger specs, JSON schema files, protocol definition files. +See the `/api` directory for examples. + ## Web Application Directories ### `/web` @@ -84,20 +88,28 @@ IaaS, PaaS, system and container orchestration deployment configurations and tem Additional external test apps and test data. +See the `/test` directory for examples. + ## Other Directories ### `/docs` Design and user documents (in addition to your godoc generated documentation). +See the `/docs` directory for examples. + ### `/tools` Supporting tools for this project. Note that these tools can import code from the `/pkg` and `/internal` directories. +See the `/tools` directory for examples. + ### `/examples` Examples for your applications and/or public libraries. +See the `/examples` directory for examples. + ### `/third_party` External helper tools, forked code and other 3rd party utilities (e.g., Swagger UI). diff --git a/api/README.md b/api/README.md index 5bc898c..c97c0a4 100644 --- a/api/README.md +++ b/api/README.md @@ -1,3 +1,7 @@ # `/api` OpenAPI/Swagger specs, JSON schema files, protocol definition files. + +Examples: + +* https://github.com/openshift/origin/tree/master/api diff --git a/cmd/README.md b/cmd/README.md index 2d6a555..f7c6e83 100644 --- a/cmd/README.md +++ b/cmd/README.md @@ -7,3 +7,7 @@ The directory name for each application should match the name of the executable Don't put a lot of code in the application directory. If you think the code can be imported and used in other projects, then it should live in the `/pkg` directory. If the code is not reusable or if you don't want others to reuse it, put that code in the `/internal` directory. You'll be surprised what others will do, so be explicit about your intentions! It's common to have a small `main` function that imports and invokes the code from the `/internal` and `/pkg` directories and nothing else. + +Examples: + +* https://github.com/heptio/ark/tree/master/cmd diff --git a/docs/README.md b/docs/README.md index 10d4502..a97147d 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,3 +1,7 @@ # `/docs` Design and user documents (in addition to your godoc generated documentation). + +Examples: + +* https://github.com/openshift/origin/tree/master/docs diff --git a/examples/README.md b/examples/README.md index d323b00..10aa073 100644 --- a/examples/README.md +++ b/examples/README.md @@ -1,3 +1,7 @@ # `/examples` Examples for your applications and/or public libraries. + +Examples: + +* https://github.com/docker-slim/docker-slim/tree/master/examples diff --git a/test/README.md b/test/README.md index 14964a7..61843dd 100644 --- a/test/README.md +++ b/test/README.md @@ -1,3 +1,9 @@ # `/test` Additional external test apps and test data. + +Examples: + +* https://github.com/openshift/origin/tree/master/test (test data is in the `/testdata` subdirectory) + + diff --git a/tools/README.md b/tools/README.md index f87cf27..f0e78ec 100644 --- a/tools/README.md +++ b/tools/README.md @@ -1,3 +1,7 @@ # `/tools` Supporting tools for this project. Note that these tools can import code from the `/pkg` and `/internal` directories. + +Examples: + +* https://github.com/openshift/origin/tree/master/tools