From c2ea12766ecc7c218240e9264f2a41c58a8eae54 Mon Sep 17 00:00:00 2001 From: Lingfei Kong Date: Sat, 3 Sep 2022 14:49:18 +0800 Subject: [PATCH] feat: add iam project example to corresponding directory Add iam project example to corresponding directory. iam is a project that strictly follows the project-layout directory structure --- api/README.md | 1 + build/README.md | 1 + cmd/README.md | 1 + configs/README.md | 4 ++++ deployments/README.md | 4 ++++ docs/README.md | 1 + examples/README.md | 1 + githooks/README.md | 4 ++++ init/README.md | 4 ++++ internal/README.md | 2 ++ pkg/README.md | 1 + scripts/README.md | 3 ++- test/README.md | 3 +-- third_party/README.md | 4 ++++ tools/README.md | 1 + 15 files changed, 32 insertions(+), 3 deletions(-) diff --git a/api/README.md b/api/README.md index b7184f8b..175e5bfe 100644 --- a/api/README.md +++ b/api/README.md @@ -6,3 +6,4 @@ Examples: * https://github.com/kubernetes/kubernetes/tree/master/api * https://github.com/moby/moby/tree/master/api +* https://github.com/marmotedu/iam/tree/master/api diff --git a/build/README.md b/build/README.md index fd6d0d4d..7fdbaa70 100644 --- a/build/README.md +++ b/build/README.md @@ -9,3 +9,4 @@ Put your CI (travis, circle, drone) configurations and scripts in the `/build/ci Examples: * https://github.com/cockroachdb/cockroach/tree/master/build +* https://github.com/marmotedu/iam/tree/master/build diff --git a/cmd/README.md b/cmd/README.md index 893105fb..47a2555c 100644 --- a/cmd/README.md +++ b/cmd/README.md @@ -17,3 +17,4 @@ Examples: * https://github.com/kubernetes/kubernetes/tree/master/cmd * https://github.com/dapr/dapr/tree/master/cmd * https://github.com/ethereum/go-ethereum/tree/master/cmd +* https://github.com/marmotedu/iam/tree/master/cmd diff --git a/configs/README.md b/configs/README.md index bf3df6d2..6e3e3947 100644 --- a/configs/README.md +++ b/configs/README.md @@ -3,3 +3,7 @@ Configuration file templates or default configs. Put your `confd` or `consul-template` template files here. + +Examples: + +* https://github.com/marmotedu/iam/tree/master/configs diff --git a/deployments/README.md b/deployments/README.md index c6e4ecba..b03b532e 100644 --- a/deployments/README.md +++ b/deployments/README.md @@ -1,3 +1,7 @@ # `/deployments` IaaS, PaaS, system and container orchestration deployment configurations and templates (docker-compose, kubernetes/helm, mesos, terraform, bosh). + +Examples: + +* https://github.com/marmotedu/iam/tree/master/deployments diff --git a/docs/README.md b/docs/README.md index 66aaf4e7..50651a0a 100644 --- a/docs/README.md +++ b/docs/README.md @@ -7,3 +7,4 @@ Examples: * https://github.com/gohugoio/hugo/tree/master/docs * https://github.com/openshift/origin/tree/master/docs * https://github.com/dapr/dapr/tree/master/docs +* https://github.com/marmotedu/iam/tree/master/docs diff --git a/examples/README.md b/examples/README.md index f76539e6..844a97a4 100644 --- a/examples/README.md +++ b/examples/README.md @@ -8,3 +8,4 @@ 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 +* https://github.com/marmotedu/iam/tree/master/examples diff --git a/githooks/README.md b/githooks/README.md index 741899af..ec8ff7d5 100644 --- a/githooks/README.md +++ b/githooks/README.md @@ -1,3 +1,7 @@ # `/githooks` Git hooks. + +Examples: + +* https://github.com/marmotedu/iam/tree/master/githooks diff --git a/init/README.md b/init/README.md index 1544dec4..1ae4119b 100644 --- a/init/README.md +++ b/init/README.md @@ -1,3 +1,7 @@ # `/init` System init (systemd, upstart, sysv) and process manager/supervisor (runit, supervisord) configs. + +Examples: + +* https://github.com/marmotedu/iam/tree/master/init diff --git a/internal/README.md b/internal/README.md index 285acfa0..7f40b031 100644 --- a/internal/README.md +++ b/internal/README.md @@ -12,9 +12,11 @@ Examples: * https://github.com/jaegertracing/jaeger/tree/master/internal * https://github.com/moby/moby/tree/master/internal * https://github.com/satellity/satellity/tree/master/internal +* https://github.com/marmotedu/iam/tree/master/internal ## `/internal/pkg` Examples: * https://github.com/hashicorp/waypoint/tree/main/internal/pkg +* https://github.com/marmotedu/iam/tree/master/internal/pkg diff --git a/pkg/README.md b/pkg/README.md index 6d70c82c..780e03b7 100644 --- a/pkg/README.md +++ b/pkg/README.md @@ -56,3 +56,4 @@ Examples: * https://github.com/kata-containers/runtime/tree/master/pkg * https://github.com/okteto/okteto/tree/master/pkg * https://github.com/solo-io/squash/tree/master/pkg +* https://github.com/marmotedu/iam/tree/master/pkg diff --git a/scripts/README.md b/scripts/README.md index edb724ef..6a0b6f2a 100644 --- a/scripts/README.md +++ b/scripts/README.md @@ -8,4 +8,5 @@ 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 +* https://github.com/hashicorp/terraform/tree/master/scripts +* https://github.com/marmotedu/iam/tree/master/scripts diff --git a/test/README.md b/test/README.md index cdcf65f4..1c0e1bc7 100644 --- a/test/README.md +++ b/test/README.md @@ -5,5 +5,4 @@ Additional external test apps and test data. Feel free to structure the `/test` Examples: * https://github.com/openshift/origin/tree/master/test (test data is in the `/testdata` subdirectory) - - +* https://github.com/marmotedu/iam/tree/master/test diff --git a/third_party/README.md b/third_party/README.md index cc530ca3..8ef060b9 100644 --- a/third_party/README.md +++ b/third_party/README.md @@ -1,3 +1,7 @@ # `/third_party` External helper tools, forked code and other 3rd party utilities (e.g., Swagger UI). + +Examples: + +* https://github.com/marmotedu/iam/tree/master/third_party diff --git a/tools/README.md b/tools/README.md index f22a58e3..ad470fb6 100644 --- a/tools/README.md +++ b/tools/README.md @@ -7,3 +7,4 @@ Examples: * https://github.com/istio/istio/tree/master/tools * https://github.com/openshift/origin/tree/master/tools * https://github.com/dapr/dapr/tree/master/tools +* https://github.com/marmotedu/iam/tree/master/tools