Skip to content

Add make command to docs to install dependencies #4572

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

Merged
khanhtc1202 merged 2 commits into from
Aug 28, 2023
Merged

Add make command to docs to install dependencies #4572

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2cbb2a0
add: make command for dependency installation
ren510dev Aug 28, 2023
69109f4
Merge branch 'master' into update-docs
ren510dev Aug 28, 2023
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
10 changes: 8 additions & 2 deletions cmd/pipecd/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,13 @@ For the full list of available commands, please see the Makefile at the root of

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

2. Install Control Plane into the local cluster
2. Install the web dependencies module

``` console
make update/web-deps
```

3. Install Control Plane into the local cluster

``` console
make run/pipecd
Expand All @@ -42,7 +48,7 @@ For the full list of available commands, please see the Makefile at the root of
kubectl -n pipecd port-forward svc/pipecd 8080
```

3. Access to the local Control Plane web console
4. 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`.

Expand Down
12 changes: 9 additions & 3 deletions docs/content/en/docs-v0.43.x/contribution-guidelines/development.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,13 @@ For the full list of available commands, please see the Makefile at the root of

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

2. Install Control Plane into the local cluster
2. Install the web dependencies module

``` console
make update/web-deps
```

3. Install Control Plane into the local cluster

``` console
make run/pipecd
Expand All @@ -55,7 +61,7 @@ For the full list of available commands, please see the Makefile at the root of
kubectl -n pipecd port-forward svc/pipecd 8080
```

3. Access to the local Control Plane web console
4. 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`.

Expand Down Expand Up @@ -91,4 +97,4 @@ In such case, update the docs under `/docs-dev` is enough.
- Change the docs' content that fixes the issue under `/docs-dev` and `/docs-v0.x.x`, they share the same file structure so you should find the right files in both directories.
- Use `make gen/stable-docs` command to sync the latest released version docs under `/docs-v0.x.x` to `/docs`

If you find any issues related to the docs, we're happy to accept your help.
If you find any issues related to the docs, we're happy to accept your help.