Skip to content

Conversation

Catalin-Stratulat-Ericsson
Copy link
Contributor

new baseline to work off of

Copy link

netlify bot commented Oct 3, 2025

Deploy Preview for porch-docs-refactor ready!

Name Link
🔨 Latest commit 1176308
🔍 Latest deploy log https://app.netlify.com/projects/porch-docs-refactor/deploys/68e8f9b974f4560008d15aa0
😎 Deploy Preview https://deploy-preview-262--porch-docs-refactor.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.

@CsatariGergely
Copy link
Contributor

/lgtm

@CsatariGergely
Copy link
Contributor

How much do we want to keep the links correct here? I think it is needed at the end that all the links are correct, but I do not want to be the links to be a blocker to start the work.

@nephio-prow nephio-prow bot added the approved label Oct 6, 2025
@liamfallon
Copy link
Member

/approve
/lgtm

Copy link
Contributor

nephio-prow bot commented Oct 6, 2025

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: liamfallon

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

The pull request process is described here

Needs approval from an approver in each of these files:

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

Signed-off-by: Michael Greaves <michael.greaves@nokia.com>
mpgreaves and others added 3 commits October 9, 2025 10:01
Signed-off-by: Michael Greaves <michael.greaves@nokia.com>
Co-authored-by: Catalin Stratulat <159934629+Catalin-Stratulat-Ericsson@users.noreply.github.com>
…nce npm scripts (nephio-project#256)

This pull request introduces a series of improvements to the
documentation repository, focusing on correcting configuration metadata,
upgrading core dependencies, and enhancing the developer workflow. These
changes address technical debt and align the project with modern best
practices.

### Key Changes:

**1. `package.json` Overhaul:**
- **Fixed Typo:** Corrected the package name in `name` field from
`nephio-rpoject-docs` to `nephio-project-docs`.
- **Aligned License:** Updated the `license` field from `APACHE2` to
`CC-BY-4.0` to match the repository's `LICENSE` file.
- **Added Description:** Populated the empty `description` field with a
clear and concise project summary.
- **Enhanced Discoverability:** Added relevant keywords to the
`keywords` array.
- **Implemented npm Scripts:** Introduced a standard set of scripts for
better workflow automation:
  - `build`: For production builds (`hugo --gc --minify`).
  - `serve`: For local development (`hugo server -D`).
  - `lint`: For running quality checks.
  - `test`: An alias for the `lint` script.

**2. Core Dependency Upgrades:**
- **Hugo & Go:** Upgraded `HUGO_VERSION` to `0.148.2` and `GO_VERSION`
to `1.24.5` in `netlify.toml` and `go.mod` to leverage the latest
features, performance improvements, and security patches.
- **Docsy Theme:** Updated the Docsy theme requirement to `v0.12.0` in
`go.mod`.
- Ran `go mod tidy` to ensure all dependencies are consistent.

**3. Code Cleanup:**
- **Removed Redundancy:** Deleted a duplicate `!include` statement in
`diagrams/src/level3-nephio-porch-component.puml` to fix the diagram
definition.

These changes collectively improve the project's maintainability,
security, and developer experience.

Signed-off-by: Hsiu-Chi Tsai
<[84045975+thc1006@users.noreply.github.com](mailto:84045975+thc1006@users.noreply.github.com)
>"
@nephio-prow nephio-prow bot removed the lgtm label Oct 10, 2025
Copy link
Contributor

nephio-prow bot commented Oct 10, 2025

New changes are detected. LGTM label has been removed.

Copy link


{{% alert title="Note" color="primary" %}}

Installation of Porch, including its prerequisites, is covered in a [dedicated document](install-porch.md).
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Installation of Porch, including its prerequisites, is covered in a [dedicated document](install-porch.md).
Installation of Porch, including its prerequisites, is covered in a [dedicated document](./install-porch.md).


The porch server handles interaction with associated git repositories through the use of porch repository CR (Custom Resource) which act as a link between the porch server and the git repositories the server is meant to interact with and store packages on.

More information on porch repositories can be found [here](../package-orchestration.md#repositories).
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
More information on porch repositories can be found [here](../package-orchestration.md#repositories).
More information on porch repositories can be found [here](../../porch/package-orchestration.md#repositories).

Comment on lines +86 to +89
* [Configuration as Data](https://docs.nephio.org/docs/porch/concepts/configuration-as-data/)
* [Package Mutation Pipeline Order](https://docs.nephio.org/docs/porch/concepts/package-mutation-pipeline/)
* [Function Runner Pod Templating](https://docs.nephio.org/docs/porch/concepts/function-runner/)
* [Package Variant Controller](https://docs.nephio.org/docs/porch/concepts/variant-controller/)
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
* [Configuration as Data](https://docs.nephio.org/docs/porch/concepts/configuration-as-data/)
* [Package Mutation Pipeline Order](https://docs.nephio.org/docs/porch/concepts/package-mutation-pipeline/)
* [Function Runner Pod Templating](https://docs.nephio.org/docs/porch/concepts/function-runner/)
* [Package Variant Controller](https://docs.nephio.org/docs/porch/concepts/variant-controller/)
<!--- TODO: replace with published links -->
* [Configuration as Data](https://docs.nephio.org/docs/porch/)
<!--- https://docs.nephio.org/docs/porch/concepts/configuration-as-data/ -->
* [Package Mutation Pipeline Order](https://docs.nephio.org/docs/porch/)
<!--- https://docs.nephio.org/docs/porch/concepts/package-mutation-pipeline/ -->
* [Function Runner Pod Templating](https://docs.nephio.org/docs/porch/)
<!--- https://docs.nephio.org/docs/porch/concepts/function-runner/ -->
* [Package Variant Controller](https://docs.nephio.org/docs/porch/)
<!--- https://docs.nephio.org/docs/porch/concepts/variant-controller/ -->

@efiacor efiacor merged commit 76debfc into nephio-project:porch-docs-refactor Oct 10, 2025
7 of 9 checks passed
@efiacor efiacor deleted the neo-porch-baseline branch October 10, 2025 12:47
lapentad pushed a commit to Nordix/nephio-docs that referenced this pull request Oct 17, 2025
new baseline to work off of

---------

Signed-off-by: Michael Greaves <michael.greaves@nokia.com>
Signed-off-by: Hsiu-Chi Tsai
Co-authored-by: mpgreaves <103421482+mpgreaves@users.noreply.github.com>
Co-authored-by: 蔡秀吉 <84045975+thc1006@users.noreply.github.com>
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.

7 participants