Skip to content

chore(docs): Correct package metadata, upgrade dependencies, and enhance npm scripts #256

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

thc1006
Copy link

@thc1006 thc1006 commented Aug 3, 2025

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 <[email protected] >"

Copy link

netlify bot commented Aug 3, 2025

Deploy Preview for nephio ready!

Name Link
🔨 Latest commit e19282e
🔍 Latest deploy log https://app.netlify.com/projects/nephio/deploys/688f17d594ac5400088b3377
😎 Deploy Preview https://deploy-preview-256--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.

@nephio-prow nephio-prow bot requested review from CsatariGergely and timop62 August 3, 2025 07:37
Copy link
Contributor

nephio-prow bot commented Aug 3, 2025

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign arora-sagar for approval by writing /assign @arora-sagar in a comment. For more information see the Kubernetes Code Review Process.

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 /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

Copy link
Contributor

nephio-prow bot commented Aug 3, 2025

Hi @thc1006. Thanks for your PR.

I'm waiting for a nephio-project member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

thc1006 added 3 commits August 3, 2025 15:44
…mentation repository. The build is failing with Hugo v0.148.2 due to template system changes introduced in Hugo v0.146.0.
…mentation repository. The build is failing with Hugo v0.148.2 due to template system changes introduced in Hugo v0.146.0.
Copy link

sonarqubecloud bot commented Aug 3, 2025

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.

1 participant