From 209f8fb793ee8b0b82eba76057df9124f3e26872 Mon Sep 17 00:00:00 2001 From: Tetsuya Kikuchi <97105818+t-kikuc@users.noreply.github.com> Date: Fri, 15 Mar 2024 15:47:09 +0900 Subject: [PATCH] [doc] Add links to each README.md of components (#4828) * Add link to each README.md of pipecd,piped Signed-off-by: t-kikuc * Add link to each README.md of web,docs Signed-off-by: t-kikuc --------- Signed-off-by: t-kikuc --- CONTRIBUTING.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5e13ce5341..37b9133d87 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -72,12 +72,12 @@ If you want to work on any of these issues, simply leave a message saying "I'd l PipeCD consists of several components and docs: -- **cmd/pipecd**: A centralized component that manages deployment data and provides a gRPC API for connecting pipeds, as well as web functionalities such as authentication. -- **cmd/piped**: piped is an agent component that runs in your cluster. -- **cmd/pipectl**: The command-line tool for PipeCD. -- **cmd/launcher**: The command executor that enables the remote upgrade feature of the piped agent. -- **web**: The web application provided by the control plane. -- **docs**: Documentation and references. +- **cmd/pipecd**: A centralized component that manages deployment data and provides a gRPC API for connecting pipeds, as well as web functionalities such as authentication. [README.md](./cmd/pipecd/README.md) +- **cmd/piped**: piped is an agent component that runs in your cluster. [README.md](./cmd/piped/README.md) +- **cmd/pipectl**: The command-line tool for PipeCD. [README.md](./cmd/pipectl/README.md) +- **cmd/launcher**: The command executor that enables the remote upgrade feature of the piped agent. [README.md](./cmd/launcher/README.md) +- **web**: The web application provided by the control plane. [README.md](./web/README.md) +- **docs**: Documentation and references. [README.md](./docs/README.md) **You can find detailed development information in the README file of each directory.**