Sync porch refactor on main #267
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Michael Greaves <michael.greaves@nokia.com>
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 (#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) >"
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
✅ Deploy Preview for nephio ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
✅ Deploy Preview for porch-docs-refactor ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
lapentad
pushed a commit
to Nordix/nephio-docs
that referenced
this pull request
Oct 17, 2025
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: Catalin Stratulat <159934629+Catalin-Stratulat-Ericsson@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
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.