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.

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

Refactor docs for contributor #3592

Merged
merged 5 commits into from
May 9, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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

This file was deleted.

42 changes: 39 additions & 3 deletions docs/content/en/docs-dev/contribution-guidelines/development.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ description: >

- [Go 1.17](https://go.dev/)
- [Docker Decktop](https://www.docker.com/products/docker-desktop/)
- [kind](https://kind.sigs.k8s.io/docs/user/quick-start/#installation) (If you want to run Control Plane locally)
khanhtc1202 marked this conversation as resolved.
Show resolved Hide resolved

## Repositories
- [pipecd](https://github.com/pipe-cd/pipecd): contains all source code and documentation of PipeCD project.
Expand All @@ -24,15 +25,50 @@ description: >
- `make test/web`: runs all unit tests of web.
- `make test/integration`: runs integration tests.

- `make run/pipecd`: runs Control Plane locally.
- `make run/piped`: runs Piped Agent locally.
- `make run/web`: runs frontend locally.
- `make run/site`: runs PipeCD site locally (requires [hugo](https://github.com/gohugoio/hugo) with `_extended` version `0.92.1` or later to be installed).

- `make gen/code`: generate Go and Typescript code from protos and mock configs. You need to run it if you modified any proto or mock definition files.

For the full list of available commands, please see the Makefile at the root of repository.

## How to run Control Plane locally
nghialv marked this conversation as resolved.
Show resolved Hide resolved

1. Start running a Kubernetes cluster

``` console
make kind-up
```

Once it is no longer used, run `make kind-down` to delete it.

2. Install Control Plane into the local cluster

``` console
make run/pipecd
```

Once all components are running up, use `kubectl port-forward` to expose the installed Control Plane on your localhost:

``` console
kubectl -n pipecd port-forward svc/pipecd 8080
```

3. Access to the local Control Plane web console

Point your web browser to [http://localhost:8080](http://localhost:8080) to login with the configured static admin account: project = `quickstart`, username = `hello-pipecd`, password = `hello-pipecd`.

## How to run Piped agent locally

1. Prepare the piped configuration file `piped-config.yaml`

2. Ensure that your `kube-context` is connecting to the right kubernetes cluster

3. Run the following command to start running `piped`

``` console
make run/piped CONFIG_FILE=piped-config.yaml
```

## Docs and workaround with docs

PipeCD official site contains multiple versions of documentation, all placed under the `/docs/content/en` directory, which are:
Expand Down

This file was deleted.

2 changes: 1 addition & 1 deletion web/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ src
We use `msw` for mocking API, so you can see UI without running API server.

```bash
make web-dev
make run/web
```

The app will be available at http://localhost:9090.
Expand Down