-
Notifications
You must be signed in to change notification settings - Fork 34
added new baseline #262
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
added new baseline #262
Conversation
✅ Deploy Preview for porch-docs-refactor ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
/lgtm |
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. |
/approve |
[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 |
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 (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) >"
New changes are detected. LGTM label has been removed. |
|
|
||
{{% alert title="Note" color="primary" %}} | ||
|
||
Installation of Porch, including its prerequisites, is covered in a [dedicated document](install-porch.md). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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). |
* [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/) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
* [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/ --> |
76debfc
into
nephio-project:porch-docs-refactor
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>
new baseline to work off of