Skip to content

[Doc refactor] - port old package-orchestration.md to new 2_concepts section#269

Merged
nephio-prow[bot] merged 29 commits intonephio-project:mainfrom
Nordix:porch-concepts-refactor
Nov 7, 2025
Merged

[Doc refactor] - port old package-orchestration.md to new 2_concepts section#269
nephio-prow[bot] merged 29 commits intonephio-project:mainfrom
Nordix:porch-concepts-refactor

Conversation

@JamesMcDermott
Copy link
Contributor

@JamesMcDermott JamesMcDermott commented Oct 10, 2025

  • rework structure to separate into three separate documents: fundamentals, theory, and architecture
  • also port in config-as-data.md as part of the theory document
    • explains several principles underlying Package Orchestration
  • mostly copy-paste otherwise
    • cleaned up a lot of awkward wording
    • new mentions of Package Revision and Package Variant concepts
  • fix some typos across other files

…section

- mostly copy-paste
  - cleaned up a lot of awkward wording
  - new mentions of Package Revision and Package Variant concepts
- to keep it high-level:
  - extract some deeper exploration of Package Orchestration concepts to
    separate concepts_elaborated.md file
  - remov deeper architecture descriptions of Porch Server, Function Runner,
    and CaD Library to 5_architecture_&_components section
    - they may be useful when we get to that section in depth
- fix "explination" typo across all files
JamesMcDermott and others added 2 commits October 16, 2025 18:14
Adding light/dark mode themes to documentation as user prefers.
Toggle Button is in the top right corner and can be viewed in preview.
It should auto adjust to the users browser settings

---------

Co-authored-by: JamesMcDermott <james.j.mcdermott@ericsson.com>
@JamesMcDermott JamesMcDermott changed the base branch from porch-docs-refactor to main October 17, 2025 10:05
@netlify
Copy link

netlify bot commented Oct 17, 2025

Deploy Preview for nephio ready!

Name Link
🔨 Latest commit f129b7f
🔍 Latest deploy log https://app.netlify.com/projects/nephio/deploys/690c83f4aa3b4300087c1d9b
😎 Deploy Preview https://deploy-preview-269--nephio.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

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

@Catalin-Stratulat-Ericsson
Copy link
Contributor

thank you for porting over to the main branch @JamesMcDermott sorry for the hassle

@nephio-project nephio-project deleted a comment from netlify bot Oct 22, 2025
JamesMcDermott and others added 16 commits October 24, 2025 10:58
- ported config-as-data.md into theory from Overview section as it fits better
- former porch_concepts/porch_concepts_elaborated structure removed
- added blurb for Concepts section in _index.md
The relref syntax used previously was using the old shortcode in hugo
and as such caused warnings at build stage these have been amended to
use the up to date syntax.
Secondly when using the correct relref syntax problems arise when hugo
parses the "&" symbol in folder names and seems to ignore/nullify this
symbol leading to failing build. rectified by renaming the folders and
replacing any instance of "&" with "and"
…section

- mostly copy-paste
  - cleaned up a lot of awkward wording
  - new mentions of Package Revision and Package Variant concepts
- to keep it high-level:
  - extract some deeper exploration of Package Orchestration concepts to
    separate concepts_elaborated.md file
  - remov deeper architecture descriptions of Porch Server, Function Runner,
    and CaD Library to 5_architecture_&_components section
    - they may be useful when we get to that section in depth
- fix "explination" typo across all files
- ported config-as-data.md into theory from Overview section as it fits better
- former porch_concepts/porch_concepts_elaborated structure removed
- added blurb for Concepts section in _index.md
- also rename two files to remove ampersands
- add descriptions to Hugo header elements in each doc
  to improve presentation in rendered site
- copy rewrites of old config-as-data content back to
  the copies in relevant relevant_old_docs documents
  so as not to lose them
- other minor tweaks from offline review comments
- port some last bits in from kpt documentation
@Catalin-Stratulat-Ericsson
Copy link
Contributor

/approve im happy with this becoming our new concepts section.
great job @JamesMcDermott any reviews are welcome.

@nephio-prow nephio-prow bot added the approved label Oct 30, 2025
For additional ease of use, the PackageRevision resource type applies a Kubernetes label to the latest package revision
when read using the `porchctl` or `kubectl` CLI: `kpt.dev/latest-revision: "true"`

### Package Relationships - Upstream and Downstream
Copy link
Collaborator

Choose a reason for hiding this comment

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

Important but too low level for here

Copy link
Contributor

Choose a reason for hiding this comment

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

Should we move this to some other place or just delete them from here?

@sonarqubecloud
Copy link

sonarqubecloud bot commented Nov 6, 2025

@efiacor
Copy link
Collaborator

efiacor commented Nov 7, 2025

/approve
/lgtm

@nephio-prow nephio-prow bot added the lgtm label Nov 7, 2025
@nephio-prow
Copy link
Contributor

nephio-prow bot commented Nov 7, 2025

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: Catalin-Stratulat-Ericsson, efiacor

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details Needs approval from an approver in each of these files:
  • OWNERS [Catalin-Stratulat-Ericsson,efiacor]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@nephio-prow nephio-prow bot merged commit 77abcca into nephio-project:main Nov 7, 2025
9 checks passed
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.

5 participants