Skip to content

Docs main placeholder pr concept#1026

Merged
liamfallon merged 8 commits into
kptdev:mainfrom
Nordix:docs-main-placeholder-pr-concept
Jun 25, 2026
Merged

Docs main placeholder pr concept#1026
liamfallon merged 8 commits into
kptdev:mainfrom
Nordix:docs-main-placeholder-pr-concept

Conversation

@Catalin-Stratulat-Ericsson

@Catalin-Stratulat-Ericsson Catalin-Stratulat-Ericsson commented Jun 3, 2026

Copy link
Copy Markdown
Contributor

Title

Adding concept for main/placeholder PackageRevision


Description

  • What changed: Added a new concept section for the main/placeholder revision
  • Why it’s needed: There is no real explanation of how the main pr works, when its created, why its created, how its updated, why it doesn't rollback to latest-1 if the latest is deleted where main is pointing at
  • How it works: Just refactored the small point mentioning it in the concepts introduction and added a separate section

Related Issue(s)

  • Closes/Fixes #

Type of Change

  • Bug fix
  • New feature
  • Enhancement
  • Refactor
  • Documentation
  • Tests
  • Other: ________

Checklist

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

Testing Instructions (Optional)

  1. just open the netlify preview and look at the new section in the concepts

Additional Notes (Optional)

  • Known issues:
  • Further improvements:
  • Review notes:

AI Disclosure

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

If so, please describe how:

  • E.g. Used Amazon Q Dev to template initial draft of my thoughts on how it operates

Signed-off-by: Catalin-Stratulat-Ericsson <catalin.stratulat@ericsson.com>
Signed-off-by: Catalin-Stratulat-Ericsson <catalin.stratulat@ericsson.com>
Copilot AI review requested due to automatic review settings June 3, 2026 14:49
@netlify

netlify Bot commented Jun 3, 2026

Copy link
Copy Markdown

Deploy Preview for kpt-porch ready!

Name Link
🔨 Latest commit 1b9477b
🔍 Latest deploy log https://app.netlify.com/projects/kpt-porch/deploys/6a3cdb7c522e930008985622
😎 Deploy Preview https://deploy-preview-1026--kpt-porch.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.

Copilot AI 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.

Pull request overview

Note

Copilot was unable to run its full agentic suite in this review.

Adds dedicated documentation for “placeholder package revisions” and updates the Concepts index to link to the new page.

Changes:

  • Added a new concepts doc page describing placeholder package revision behavior, lifecycle, rollback semantics, and GitOps relationship
  • Replaced the inline placeholder description in the concepts index with a relref link + shorter summary

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.

File Description
docs/content/en/docs/2_concepts/placeholder-package-revision.md New doc page defining placeholder package revisions and explaining lifecycle/usage constraints
docs/content/en/docs/2_concepts/_index.md Replaces long inline placeholder description with a link to the new dedicated doc page

Comment thread docs/content/en/docs/2_concepts/placeholder-package-revision.md
Comment thread docs/content/en/docs/2_concepts/placeholder-package-revision.md Outdated
Comment thread docs/content/en/docs/2_concepts/placeholder-package-revision.md
Comment thread docs/content/en/docs/2_concepts/placeholder-package-revision.md
@Catalin-Stratulat-Ericsson Catalin-Stratulat-Ericsson marked this pull request as ready for review June 3, 2026 15:12
@Catalin-Stratulat-Ericsson Catalin-Stratulat-Ericsson added the documentation Improvements or additions to documentation label Jun 10, 2026
Comment thread docs/content/en/docs/2_concepts/placeholder-package-revision.md Outdated
Comment thread docs/content/en/docs/2_concepts/placeholder-package-revision.md
Comment thread docs/content/en/docs/2_concepts/placeholder-package-revision.md Outdated
@sonarqubecloud

Copy link
Copy Markdown

Comment thread docs/content/en/docs/2_concepts/_index.md Outdated
Comment thread docs/content/en/docs/2_concepts/placeholder-package-revision.md Outdated
Comment thread docs/content/en/docs/2_concepts/placeholder-package-revision.md Outdated
Comment thread docs/content/en/docs/2_concepts/placeholder-package-revision.md Outdated
Comment thread docs/content/en/docs/2_concepts/placeholder-package-revision.md Outdated
Comment thread docs/content/en/docs/2_concepts/placeholder-package-revision.md Outdated
Comment thread docs/content/en/docs/2_concepts/placeholder-package-revision.md Outdated
Comment thread docs/content/en/docs/2_concepts/placeholder-package-revision.md Outdated
Comment thread docs/content/en/docs/2_concepts/placeholder-package-revision.md Outdated
Comment thread docs/content/en/docs/2_concepts/placeholder-package-revision.md
Comment thread docs/content/en/docs/2_concepts/placeholder-package-revision.md Outdated
Comment thread docs/content/en/docs/2_concepts/placeholder-package-revision.md Outdated
Comment thread docs/content/en/docs/2_concepts/placeholder-package-revision.md Outdated
Comment thread docs/content/en/docs/2_concepts/placeholder-package-revision.md Outdated
@Catalin-Stratulat-Ericsson Catalin-Stratulat-Ericsson requested review from a team June 24, 2026 12:25
@dosubot dosubot Bot added the size:L This PR changes 100-499 lines, ignoring generated files. label Jun 24, 2026
Co-authored-by: Liam Fallon <35595825+liamfallon@users.noreply.github.com>
Co-authored-by: JamesMcDermott <james.j.mcdermott@ericsson.com>
Co-authored-by: Rendre Greyling <rendre.greyling@nokia.com>
Signed-off-by: Catalin Stratulat <159934629+Catalin-Stratulat-Ericsson@users.noreply.github.com>
Signed-off-by: Catalin-Stratulat-Ericsson <catalin.stratulat@ericsson.com>
…de git without porch on front page

Signed-off-by: Catalin-Stratulat-Ericsson <catalin.stratulat@ericsson.com>
Comment thread docs/content/en/docs/2_concepts/placeholder-package-revision.md Outdated
Comment thread docs/content/en/docs/2_concepts/placeholder-package-revision.md Outdated
@JamesMcDermott

Copy link
Copy Markdown
Contributor

Couple more wording adjustment comments

applied the last of the suggestions

Co-authored-by: JamesMcDermott <james.j.mcdermott@ericsson.com>
Signed-off-by: Catalin Stratulat <159934629+Catalin-Stratulat-Ericsson@users.noreply.github.com>
@liamfallon liamfallon merged commit be2747b into kptdev:main Jun 25, 2026
21 checks passed
liamfallon added a commit that referenced this pull request Jun 25, 2026
* Docs main placeholder pr concept (#1026)

* Adding concept for main/placeholder PackageRevision

Signed-off-by: Catalin-Stratulat-Ericsson <catalin.stratulat@ericsson.com>

* missed newline

Signed-off-by: Catalin-Stratulat-Ericsson <catalin.stratulat@ericsson.com>

* Apply suggestions from code review

Co-authored-by: Liam Fallon <35595825+liamfallon@users.noreply.github.com>
Co-authored-by: JamesMcDermott <james.j.mcdermott@ericsson.com>
Co-authored-by: Rendre Greyling <rendre.greyling@nokia.com>
Signed-off-by: Catalin Stratulat <159934629+Catalin-Stratulat-Ericsson@users.noreply.github.com>

* addressing comments about main deletion + summary table amends

Signed-off-by: Catalin-Stratulat-Ericsson <catalin.stratulat@ericsson.com>

* removing dangerous statement about user modification of packages inside git without porch on front page

Signed-off-by: Catalin-Stratulat-Ericsson <catalin.stratulat@ericsson.com>

* Apply suggestions from code review

applied the last of the suggestions

Co-authored-by: JamesMcDermott <james.j.mcdermott@ericsson.com>
Signed-off-by: Catalin Stratulat <159934629+Catalin-Stratulat-Ericsson@users.noreply.github.com>

---------

Signed-off-by: Catalin-Stratulat-Ericsson <catalin.stratulat@ericsson.com>
Signed-off-by: Catalin Stratulat <159934629+Catalin-Stratulat-Ericsson@users.noreply.github.com>
Co-authored-by: Fiachra Corcoran <fiachra.corcoran@est.tech>
Co-authored-by: Liam Fallon <35595825+liamfallon@users.noreply.github.com>
Co-authored-by: JamesMcDermott <james.j.mcdermott@ericsson.com>
Co-authored-by: Rendre Greyling <rendre.greyling@nokia.com>

* addressing grammar comments

Signed-off-by: Catalin-Stratulat-Ericsson <catalin.stratulat@ericsson.com>

---------

Signed-off-by: Catalin-Stratulat-Ericsson <catalin.stratulat@ericsson.com>
Signed-off-by: Catalin Stratulat <159934629+Catalin-Stratulat-Ericsson@users.noreply.github.com>
Co-authored-by: Fiachra Corcoran <fiachra.corcoran@est.tech>
Co-authored-by: Liam Fallon <35595825+liamfallon@users.noreply.github.com>
Co-authored-by: JamesMcDermott <james.j.mcdermott@ericsson.com>
Co-authored-by: Rendre Greyling <rendre.greyling@nokia.com>
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 #ededed size:L This PR changes 100-499 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants