Skip to content

Docs: Clarify the use of --reconcile-timeout in getting-started guide - #4689

Open
aravindtga wants to merge 1 commit into
kptdev:mainfrom
Nordix:clarify-reconcile-timeout
Open

Docs: Clarify the use of --reconcile-timeout in getting-started guide#4689
aravindtga wants to merge 1 commit into
kptdev:mainfrom
Nordix:clarify-reconcile-timeout

Conversation

@aravindtga

Copy link
Copy Markdown
Contributor

Description

  • What changed: Updated the getting-started guide to explain why --reconcile-timeout=15m is used in kpt live apply examples.
  • Why it's needed: The previous text did not explain the timeout aspect or what happens without the flag, which was reported in Clarify the use of --reconcile-timeout in kpt live apply #1865.
  • How it works: Replaced the brief one-liner with an explanation that clarifies what the flag does, what happens without it (waits indefinitely), and why setting a timeout is recommended.

Related Issue(s)

Type of Change

  • Documentation

Checklist

  • Code follows project style guidelines
  • Self-reviewed changes
  • Tests added/updated
  • Documentation added/updated
  • All tests and gating checks pass

AI Disclosure

  • I have used AI in the creation of this PR.

If so, please describe how:
- Kiro to investigate the issue, compare --reconcile-timeout behaviour with other tools (kubectl, Helm), draft the documentation fix and draft PR message.

Signed-off-by: Aravindhan Ayyanathan <aravindhan.a@est.tech>
@netlify

netlify Bot commented Aug 10, 2026

Copy link
Copy Markdown

Deploy Preview for kptdocs ready!

Name Link
🔨 Latest commit 2898062
🔍 Latest deploy log https://app.netlify.com/projects/kptdocs/deploys/6a79af53cec24300088a8c58
😎 Deploy Preview https://deploy-preview-4689--kptdocs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

@aravindtga aravindtga self-assigned this Aug 10, 2026
@aravindtga
aravindtga marked this pull request as ready for review August 10, 2026 11:01
@aravindtga
aravindtga requested review from a team August 10, 2026 11:01
@dosubot dosubot Bot added size:XS This PR changes 0-9 lines, ignoring generated files. documentation Improvements or additions to documentation labels Aug 10, 2026
@dosubot dosubot Bot added the lgtm label Aug 10, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation lgtm size:XS This PR changes 0-9 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Clarify the use of --reconcile-timeout in kpt live apply

2 participants