Skip to content

Kpt repo cleanup 1#4640

Open
efiacor wants to merge 6 commits into
kptdev:mainfrom
Nordix:kpt_repo_cleanup_1
Open

Kpt repo cleanup 1#4640
efiacor wants to merge 6 commits into
kptdev:mainfrom
Nordix:kpt_repo_cleanup_1

Conversation

@efiacor

@efiacor efiacor commented Jul 16, 2026

Copy link
Copy Markdown
Contributor

Epic #4552 Cleanup Tasks - Complete 3 Sub-Issues

Summary

This PR completes three cleanup tasks from Epic #4552:

  1. Remove references to the site folder #4574: Remove remaining references to the deprecated site/ folder
  2. Clean up the upgrade / update terminology #4553: Standardize documentation on "update" terminology (not "upgrade")
  3. versioning, 3-way merge needs to be brought into the kpt documentation #4556: Add comprehensive 3-way merge documentation and guide

Changes

#4574 - Remove site/ folder reference

  • Removed markdown reference link [site/]: site/ from CONTRIBUTING.md
  • Verified no other site/ references remain in codebase

#4553 - Standardize terminology

  • Updated documentation/content/en/installation/migration.md to use "update" terminology consistently
  • Updated documentation/content/en/faq.md to replace "upgrade" with "update"
  • Standardizes on "update" to match kpt CLI command kpt pkg update

#4556 - Add 3-way merge documentation

  • Created comprehensive guide at documentation/content/en/guides/3-way-merge.md
    • Conceptual explanation of 3-way merge algorithm
    • Visual diagram showing merge process
    • Three merge strategies (resource-merge, fast-forward, force-delete-replace)
    • Complete worked example with nginx Deployment
    • Common use cases and best practices
    • Conflict handling workflow
    • Git integration explanation
  • Updated documentation/content/en/guides/_index.md to include new guide
  • Updated documentation/content/en/reference/cli/pkg/update/_index.md with prominent callout to guide
  • Added external links to Porch, Git merge, and Kubernetes Strategic Merge Patch

Testing

  • Verified documentation structure and link paths
  • All internal links reference existing documentation files
  • External links point to authoritative sources (GitHub, git-scm, kubernetes.io)

Closes

Closes #4574
Closes #4553
Closes #4556

efiacor added 3 commits July 16, 2026 12:43
The site/ folder has been migrated to documentation/ (Hugo-based).
This removes the obsolete [site/] markdown reference link.

Fixes: kptdev#4574
The CLI command is 'kpt pkg update', not 'upgrade'.
- CLI: commands/pkg/update/
- Docs: documentation/content/en/reference/cli/pkg/update/
- Generated docs: UpdateShort, UpdateLong, UpdateExamples

Changed 'upgraded' to 'updated' in:
- migration.md: 'fetch the package with updated version'
- faq.md: 'ability to update from an upstream package'

Fixes: kptdev#4553
- Create new guide at documentation/content/en/guides/3-way-merge.md
- Covers conceptual explanation, merge strategies, worked example, and best practices
- Links to technical reference docs to avoid duplication
- Includes practical workflow examples for security updates, version migration, and syncing
- Add strategic cross-references:
  - Updated guides/_index.md with link to new guide
  - Updated reference/cli/pkg/update/_index.md with prominent callout
  - Added external links for Porch, Git merge, and Kubernetes SMPP
- Explains Git integration: kpt uses field-level schema-aware merge vs Git's line-level merge
@efiacor
efiacor requested review from a team July 16, 2026 12:42
@netlify

netlify Bot commented Jul 16, 2026

Copy link
Copy Markdown

Deploy Preview for kptdocs ready!

Name Link
🔨 Latest commit ce11b29
🔍 Latest deploy log https://app.netlify.com/projects/kptdocs/deploys/6a58e520439cfd0007043094
😎 Deploy Preview https://deploy-preview-4640--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.

@dosubot dosubot Bot added size:L This PR changes 100-499 lines, ignoring generated files. cleanup documentation Improvements or additions to documentation labels Jul 16, 2026
@efiacor efiacor self-assigned this Jul 16, 2026
Signed-off-by: Fiachra Corcoran <fiachra.corcoran@est.tech>
@dosubot dosubot Bot added size:XXL This PR changes 1000+ lines, ignoring generated files. and removed size:L This PR changes 100-499 lines, ignoring generated files. labels Jul 16, 2026
efiacor added 2 commits July 16, 2026 14:55
Signed-off-by: Fiachra Corcoran <fiachra.corcoran@est.tech>
Signed-off-by: Fiachra Corcoran <fiachra.corcoran@est.tech>
@dosubot dosubot Bot added the lgtm label Jul 16, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cleanup documentation Improvements or additions to documentation lgtm size:XXL This PR changes 1000+ lines, ignoring generated files.

Projects

None yet

2 participants