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

Add docs for quickstart with raw manifests on README #5152

Merged
merged 1 commit into from
Aug 20, 2024

Conversation

ffjlabo
Copy link
Member

@ffjlabo ffjlabo commented Aug 20, 2024

What this PR does / why we need it:

as title

Which issue(s) this PR fixes:

Part of #5148

Does this PR introduce a user-facing change?:

  • How are users affected by this change:
  • Is this breaking change:
  • How to migrate (if breaking change):

Copy link

codecov bot commented Aug 20, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 22.79%. Comparing base (60283d0) to head (84e8c31).
Report is 1 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #5152      +/-   ##
==========================================
- Coverage   22.80%   22.79%   -0.02%     
==========================================
  Files         412      412              
  Lines       43827    43827              
==========================================
- Hits         9996     9990       -6     
- Misses      33044    33050       +6     
  Partials      787      787              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@ffjlabo ffjlabo enabled auto-merge (squash) August 20, 2024 03:52
kubectl apply -n pipecd -f ./manifests/control-plane.yaml
```

3. create piped on the Web UI
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it's nice for users to show kubectl port-forward command and URL of the Web UI.
WDYT?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Warashi
It's a nice idea. But I wonder if I should do so 🤔
For me, this doc is like a memo to describe whats the manifest is.
Also there is the actual process of the quickstart on the docs. https://pipecd.dev/docs-v0.48.x/quickstart/

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK, I got it. I agree that we have other documents about these manifests and don't have to show detailed commands here.

Copy link
Contributor

@Warashi Warashi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Copy link
Member

@khanhtc1202 khanhtc1202 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you 👍

@ffjlabo ffjlabo merged commit c0d5b79 into master Aug 20, 2024
17 of 18 checks passed
@ffjlabo ffjlabo deleted the add-docs-for-quickstart branch August 20, 2024 05:13
@github-actions github-actions bot mentioned this pull request Aug 26, 2024
This was referenced Sep 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants