Skip to content

Docs v0: improve quickstart wording - #6982

Merged
mohammedfirdouss merged 5 commits into
pipe-cd:masterfrom
rahulshendre:docs/v0-quickstart-rewrite
Jul 9, 2026
Merged

Docs v0: improve quickstart wording #6982
mohammedfirdouss merged 5 commits into
pipe-cd:masterfrom
rahulshendre:docs/v0-quickstart-rewrite

Conversation

@rahulshendre

Copy link
Copy Markdown
Contributor

What this PR does:

Why we need it:
minor clean up

Does this PR introduce a user-facing change?:

  • How are users affected by this change: docs wording only
  • Is this breaking change: no
  • How to migrate (if breaking change): n/a

Signed-off-by: rahulshendre <rahulshendre789@gmail.com>
@rahulshendre
rahulshendre requested review from a team as code owners July 5, 2026 18:46
@mohammedfirdouss
mohammedfirdouss enabled auto-merge (squash) July 5, 2026 22:27

@armistcxy armistcxy left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Overall LGTM, but can you clarify whether this part will work if we switch from /docs/ to ../: https://github.com/pipe-cd/pipecd/pull/6982/changes#diff-f55bb21231f50db5ceb096ad64110cadd5613eb9f20061e828081ee10b72739cR77

Comment thread docs/content/en/docs-v0.57.x/quickstart/_index.md

@armistcxy armistcxy left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Looks good overall

@rahulshendre

rahulshendre commented Jul 7, 2026

Copy link
Copy Markdown
Contributor Author

Overall LGTM, but can you clarify whether this part will work if we switch from /docs/ to ../: https://github.com/pipe-cd/pipecd/pull/6982/changes#diff-f55bb21231f50db5ceb096ad64110cadd5613eb9f20061e828081ee10b72739cR77

I checked this on the local build, the quickstart page sits inside the version folder (/docs-v0.57.x/quickstart/), so ../user-guide/ takes you to the user guide of the same version.
The /docs/ links work on the live site because it redirects to the latest version, but on a local build they don't go anywhere, so relative felt like the safer choice here.

also once 0.58 ships, /docs/ would send someone reading the 0.57 quickstart into the 0.58 docs, ../ keeps them on the same version.

@mohammedfirdouss

Copy link
Copy Markdown
Contributor

@rahulshendre take a look at the failed tests

Signed-off-by: Rahul Shendre <144231863+rahulshendre@users.noreply.github.com>
@rahulshendre

Copy link
Copy Markdown
Contributor Author

@mohammedfirdouss, resolved the conflict with #6791, it touched the same Control Plane line in the docs-de, all green now, the lint fail earlier is also cleared on the rerun.

@mohammedfirdouss
mohammedfirdouss merged commit 9a5c1eb into pipe-cd:master Jul 9, 2026
60 checks passed
@github-actions

github-actions Bot commented Jul 9, 2026

Copy link
Copy Markdown
Contributor

Thank you for contributing to PipeCD, @rahulshendre! The changes in this pull request will be part of the upcoming release!

@khanhtc1202 khanhtc1202 added cherry-pick v0.57.1 Release v0.57.1 labels Aug 5, 2026
@github-actions github-actions Bot mentioned this pull request Aug 5, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants