From 111c57e42e2fec4fc18cebbb26b66a4fb9407390 Mon Sep 17 00:00:00 2001 From: Oscar Utbult Date: Sat, 2 Jul 2022 00:18:24 +0200 Subject: [PATCH] Update repository-layout with missing folders --- docs/book/src/developer/repository-layout.md | 23 +++++++++++++++++--- 1 file changed, 20 insertions(+), 3 deletions(-) diff --git a/docs/book/src/developer/repository-layout.md b/docs/book/src/developer/repository-layout.md index d10beea69543..12efa69ec8aa 100644 --- a/docs/book/src/developer/repository-layout.md +++ b/docs/book/src/developer/repository-layout.md @@ -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 @@ -17,8 +18,10 @@ projectapi └───feature └───hack └───internal +└───logos └───scripts └───test +└───third_party └───util └───version └───webhooks @@ -26,6 +29,12 @@ projectapi └───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) @@ -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) @@ -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)