Add doc for quickstart #738
Conversation
|
Code coverage for golang is |
| --set-file secret.minioAccessKey.data=./quickstart/credentials/minio-access-key | ||
| --set-file secret.minioSecretKey.data=./quickstart/credentials/minio-secret-key | ||
| git clone https://github.com/pipe-cd/pipe.git | ||
| cd pipe |
There was a problem hiding this comment.
Instead of cloning pipe repository, we can clone the manifest repository and install the chart inside that repository.
helm install pipecd manifests/pipecd --values ./quickstart/values.yaml
The values file for quickstart is also copied to that repository too.
There was a problem hiding this comment.
The quickstart/ directory is also copied! Ok I'll do so.
|
|
||
| ### 3. Registering and installing a `piped` | ||
| ### 3. Accessing the API server |
There was a problem hiding this comment.
I think "the PipeCD web" is better than "API server"
quickstart/piped-config.yaml
Outdated
| syncInterval: 1m | ||
| repositories: | ||
| - repoId: examples | ||
| remote: git@github.com:pipe-cd/examples.git | ||
| remote: git@github.com:YOUR_USERNAME/examples.git |
There was a problem hiding this comment.
So let's tell the users to fork the example repository. That note can be added to the "Prerequisites" part.
There was a problem hiding this comment.
For that, added instruction to fork the repo: https://github.com/pipe-cd/pipe/pull/738/files#diff-d2444df65bafce568307b6f02d03d45dR77
|
Code coverage for golang is |
|
/hold |
nakabonne
force-pushed
the
quickstart
branch
from
1bb7038
to
31f308d
Compare
|
Code coverage for golang is |
nakabonne
force-pushed
the
quickstart
branch
from
31f308d
to
08386d7
Compare
|
Code coverage for golang is |
nakabonne
force-pushed
the
quickstart
branch
from
08386d7
to
9964495
Compare
|
/hold cancel |
|
Code coverage for golang is |
|
Code coverage for golang is |
|
Code coverage for golang is |
|
Btw, could you update the screenshots? |
|
Fixed! |
|
Code coverage for golang is |
|
|
||
|
|
||
| Open [`./quickstart/values-piped.yaml`](https://github.com/pipe-cd/manifests/blob/master/quickstart/values-piped.yaml) with your editor and: | ||
| - replace `FORKED_REPO_URL` with forked repository of [Examples](https://github.com/pipe-cd/examples), such as `https://github.com/foo/examples.git` |
There was a problem hiding this comment.
We are using SSH to clone the repository so this should be git@github.com:YOUR_ORG/examples.git.
There was a problem hiding this comment.
This message was not forwarded to slack. lol.
There was a problem hiding this comment.
In that case, users have to prepare them ssh-key and give it piped. For quickstart, I'd say clone with https scheme is enough, but what do you think?
There was a problem hiding this comment.
https://github.com/YOUR_ORG/examples.git looks good.
There was a problem hiding this comment.
Got it. The forked repo is a public one so we don't need to enter the username and password while cloning by https.
Ok. Let's update to https://github.com/YOUR_ORG/examples.git and merge this PR. 👍
|
Nice. Just left one comment. |
|
Nice. Thank you. |
|
This pull request is APPROVED by Approvers can cancel the approval by writing |
|
failed to handle template rule examples Details |
What this PR does / why we need it:
The complete doc for quickstart
Which issue(s) this PR fixes:
Fixes #
Does this PR introduce a user-facing change?: