Skip to content

Commit

Permalink
Merge pull request #6812 from k8s-infra-cherrypick-robot/cherry-pick-…
Browse files Browse the repository at this point in the history
…6806-to-release-1.2

[release-1.2] 📖 Update repository-layout with missing folders
  • Loading branch information
k8s-ci-robot authored Jul 4, 2022
2 parents b637a6c + 111c57e commit 3997fb0
Showing 1 changed file with 20 additions and 3 deletions.
23 changes: 20 additions & 3 deletions docs/book/src/developer/repository-layout.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
# Repository Layout

This page covers the repository structure and details about the directories in CAPI.
This page covers the repository structure and details about the directories in Cluster API.

```
projectapi
└───api
cluster-api
└───.github
└───api
└───bootstrap
└───cmd
│ │ clusterctl
Expand All @@ -17,15 +18,23 @@ projectapi
└───feature
└───hack
└───internal
└───logos
└───scripts
└───test
└───third_party
└───util
└───version
└───webhooks
└───main.go
└───Makefile
```

### Github

[~/.github](https://github.com/kubernetes-sigs/cluster-api/tree/main/.github)

Contains GitHub workflow configuration and templates for Pull requests, bug reports etc.

### API

[~/api](https://github.com/kubernetes-sigs/cluster-api/tree/main/api)
Expand Down Expand Up @@ -93,6 +102,10 @@ This folder contains reconciler types which provide access to CAPI controllers p

This folder is a place for proposals, developer release guidelines and the Cluster API book.

[~/logos](https://github.com/kubernetes-sigs/cluster-api/tree/main/logos)

Cluster API related logos and artwork

### Tools

[~/hack](https://github.com/kubernetes-sigs/cluster-api/tree/main/hack)
Expand All @@ -103,6 +116,10 @@ This folder has scripts used for building, testing and developer workflow.

This folder consists of CI scripts related to setup, build and e2e tests. These are mostly called by CI jobs.

[~/third_party](https://github.com/kubernetes-sigs/cluster-api/tree/main/third_party)

This folder is used to copy code from other projects in-tree.

### Util, Feature and Errors

[~/util](https://github.com/kubernetes-sigs/cluster-api/tree/main/util)
Expand Down

0 comments on commit 3997fb0

Please sign in to comment.