Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[doc] Add links to each README.md of components #4828

Merged
merged 3 commits into from
Mar 15, 2024
Merged

[doc] Add links to each README.md of components #4828

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
15fc8d7
Add link to each README.md of pipecd,piped
t-kikuc Mar 13, 2024
4cdec6a
Add link to each README.md of web,docs
t-kikuc Mar 13, 2024
8bda20c
Add link to each README.md of pipectl,launcher
t-kikuc Mar 13, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.**

Expand Down
Loading