[doc] Add links to each README.md of components (pipe-cd#4828)

* Add link to each README.md of pipecd,piped Signed-off-by: t-kikuc <[email protected]> * Add link to each README.md of web,docs Signed-off-by: t-kikuc <[email protected]> --------- Signed-off-by: t-kikuc <[email protected]>
sZma5a · Apr 18, 2024 · 209f8fb · 209f8fb
1 parent 24ee9d0
commit 209f8fb
Showing 1 changed file with 6 additions and 6 deletions.
diff --git 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.**