Skip to content

docs(fix): typos in script-run.md and installation docs#6729

Open
e-esakman wants to merge 3 commits intopipe-cd:masterfrom
e-esakman:brokenlink
Open

docs(fix): typos in script-run.md and installation docs#6729
e-esakman wants to merge 3 commits intopipe-cd:masterfrom
e-esakman:brokenlink

Conversation

@e-esakman
Copy link
Copy Markdown

What this PR does:

  • Fixes typos such as envrionmentenvironment and bellowbelow
  • Improves wording for better clarity:
  • realize it with either step belowdo that with either of the following steps
    Applies these fixes consistently across:
  • script-run.md
  • installation docs (install-controlplane-on-k8s.md)
  • multiple versioned documentation folders (docs-v0.xx.x)

Why we need it:

  • Improves clarity and readability of the documentation.
  • Keeps wording consistent across versioned docs.
    Which issue(s) this PR fixes:
    N/A

Does this PR introduce a user-facing change?:

  • Improves readability for users.
  • How are users affected by this change: N/A
  • Is this breaking change: N/A
  • How to migrate (if breaking change): N/A

Signed-off-by: e-esakman <sumansakshee36@gmail.com>
Copy link
Copy Markdown
Contributor

@Ayushmore1214 Ayushmore1214 left a comment

Choose a reason for hiding this comment

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

@e-esakman thanks for this, one thing I see is you have 2 separate PR's for the same moto (fixing typos in docs) what I would suggest is to keep one PR so it will be easy for maintainers to review it quickly, let it be for now as it is your first contribution here, but keep in mind for future contributions!

@e-esakman
Copy link
Copy Markdown
Author

@Ayushmore1214 Thanks! I split them since one is for docs/rfcs and the other for docs/docs-dev. I’ll keep in mind from next time.

Signed-off-by: e-esakman <sumansakshee36@gmail.com>
Signed-off-by: e-esakman <sumansakshee36@gmail.com>
@eeshaanSA
Copy link
Copy Markdown
Contributor

Thanks gentlemen, @Ayushmore1214 @e-esakman.

Copy link
Copy Markdown
Contributor

@eeshaanSA eeshaanSA left a comment

Choose a reason for hiding this comment

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

@e-esakman, documentation older than 0.50x need not be updated henceforth. Thanks for this. LGTM

@eeshaanSA eeshaanSA enabled auto-merge (squash) April 30, 2026 08:03
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.

3 participants