Skip to content

Commit a63ba4a

Browse files
authored
Merge pull request kubernetes-sigs#6806 from oscr/fix-repo-layout
📖 Update repository-layout with missing folders
2 parents 2067734 + e2b3086 commit a63ba4a

File tree

1 file changed

+20
-3
lines changed

1 file changed

+20
-3
lines changed

docs/book/src/developer/repository-layout.md

Lines changed: 20 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
# Repository Layout
22

3-
This page covers the repository structure and details about the directories in CAPI.
3+
This page covers the repository structure and details about the directories in Cluster API.
44

55
```
6-
projectapi
7-
└───api
6+
cluster-api
7+
└───.github
8+
└───api
89
└───bootstrap
910
└───cmd
1011
│ │ clusterctl
@@ -17,15 +18,23 @@ projectapi
1718
└───feature
1819
└───hack
1920
└───internal
21+
└───logos
2022
└───scripts
2123
└───test
24+
└───third_party
2225
└───util
2326
└───version
2427
└───webhooks
2528
└───main.go
2629
└───Makefile
2730
```
2831

32+
### Github
33+
34+
[~/.github](https://github.com/kubernetes-sigs/cluster-api/tree/main/.github)
35+
36+
Contains GitHub workflow configuration and templates for Pull requests, bug reports etc.
37+
2938
### API
3039

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

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

105+
[~/logos](https://github.com/kubernetes-sigs/cluster-api/tree/main/logos)
106+
107+
Cluster API related logos and artwork
108+
96109
### Tools
97110

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

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

119+
[~/third_party](https://github.com/kubernetes-sigs/cluster-api/tree/main/third_party)
120+
121+
This folder is used to copy code from other projects in-tree.
122+
106123
### Util, Feature and Errors
107124

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

0 commit comments

Comments
 (0)