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

Update quickstart docs #5184

Merged
merged 2 commits into from
Sep 4, 2024
Merged

Update quickstart docs #5184

merged 2 commits into from
Sep 4, 2024

Conversation

khanhtc1202
Copy link
Member

What this PR does / why we need it:

Make quickstart easier with only kubectl command required

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):

Signed-off-by: khanhtc1202 <[email protected]>
Copy link

codecov bot commented Sep 4, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 22.94%. Comparing base (e9dd4c5) to head (887ed43).
Report is 6 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #5184      +/-   ##
==========================================
+ Coverage   22.90%   22.94%   +0.03%     
==========================================
  Files         416      419       +3     
  Lines       44690    44986     +296     
==========================================
+ Hits        10238    10322      +84     
- Misses      33660    33870     +210     
- Partials      792      794       +2     

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

Warashi
Warashi previously approved these changes Sep 4, 2024
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

@t-kikuc t-kikuc left a comment

Choose a reason for hiding this comment

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

nits

docs/content/en/docs-dev/quickstart/_index.md Outdated Show resolved Hide resolved
```

##### Method 2: [Asdf](https://asdf-vm.com/) Supported Installation
The PipeCD control plane will be installed with a default project named `quickstart`. To access the PipeCD Control Plane UI, run the following command
Copy link
Member

Choose a reason for hiding this comment

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

I think we don't need to mention the default project.
If needed, The PipeCD control plane will be installed with a default project named quickstart. should be moved to the next step.

Suggested change
The PipeCD control plane will be installed with a default project named `quickstart`. To access the PipeCD Control Plane UI, run the following command
Run the following command to access the PipeCD Control Plane UI.

Copy link
Member Author

Choose a reason for hiding this comment

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

@t-kikuc I would like to keep this as is, since I mentioned the project=quickstart in the below sentence like this 👀

Screenshot 2024-09-04 at 13 22 41

Copy link
Member

Choose a reason for hiding this comment

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

OK,
I meant users don't need to know about the project when executing the portforward.

Co-authored-by: Tetsuya Kikuchi <[email protected]>
Signed-off-by: Khanh Tran <[email protected]>
Copy link
Member

@ffjlabo ffjlabo left a comment

Choose a reason for hiding this comment

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

👌

@khanhtc1202 khanhtc1202 merged commit 5fa3433 into master Sep 4, 2024
17 checks passed
@khanhtc1202 khanhtc1202 deleted the update-quickstart-docs branch September 4, 2024 06:40
@github-actions github-actions bot mentioned this pull request Sep 10, 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.

4 participants