Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,18 +12,18 @@ site. The content of this repo (especially this) branch will be a bit chaotic du
### Setting up the environment

1 The site is using Hugo as the documentation generating engine, therefore you need to install Hugo. As the Docsy
template what we use requires the transforming Sass to CSS you will need to install the *extended* version of Hugo.
template that we use requires transforming Sass to CSS, you will need to install the *extended* version of Hugo.
Link to installation instructions is [here](https://gohugo.io/installation/linux/). To ensure that you have the
*extended* version of Hugo run `hugo version` the version string should have the word extended in it. (Or `hugo
version | grep extended` should not be an empty line.)
*extended* version of Hugo, run `hugo version`. The version string should have the word extended in it (Or `hugo
version | grep extended` should not be an empty line).
2 Some functions of the theme generation are using NPM packages, therefore NodeJS and NPM will be needed. For
compaility reasons a Nove version at least v16.20.2 is needed. To install this version of NodeJS you follow the
instructions from [deb.nodesource.com](http://deb.nodesource.com/) and set `NODE_MAJOR=20`.
compatibility reasons a Node version of at least v16.20.2 is needed. To install this version of NodeJS, follow the
instructions from [deb.nodesource.com](http://deb.nodesource.com/) and set the `NODE_MAJOR=20`.
3 Install the npm dependencies with `npm install`

### Build the docs locally

To build and see the documentation locally run `hugo serve`. To doublecheck if the site will build on Netifly run `hugo
To build and see the documentation locally run `hugo serve`. To double-check if the site will build on Netifly run `hugo
--gc --minify`.


Expand Down
6 changes: 3 additions & 3 deletions content/en/docs/guides/install-guides/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -173,7 +173,7 @@ ssh <user>@<vm-address>

## Next Steps

* Step through the [exercises](https://github.com/nephio-project/docs/blob/main/user-guide/exercises.md)
* Learn more about the [Nephio demo sandbox](https://github.com/nephio-project/docs/blob/main/install-guide/explore-sandbox.md)
* Dig into the [user guide](https://github.com/nephio-project/docs/blob/main/user-guide/README.md)
* Step through the [exercises]({{< relref "exercises.md" >}})
* Learn more about the [Nephio demo sandbox]({{< relref "explore-sandbox.md" >}})
* Dig into the [user guide]({{< ref "user-guides#nephio-r1-user-guide" >}})
* Create a [Bring-Your-Own-Cluster]({{< relref "install-on-byoc.md" >}}) Nephio Installation
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Package transformations guide
description: >
Package Transformations Work in Nephio Sandbox Installation
weight: 7
weight: 6
---

# Table of Contents
Expand Down
6 changes: 3 additions & 3 deletions content/en/docs/guides/user-guides/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -330,11 +330,11 @@ The diagram below depicts deployment at the high level.

On the demo VM, the `test-infra/e2e/provision/hacks` directory contains some
workaround scripts. Also, please see the Release Notes [known
issues](https://github.com/nephio-project/docs/tree/main/release-notes#known-issues-and-workarounds).
issues](../../release-notes/r1#known-issues-and-workarounds).

## Next Steps

* Learn more about the Nephio
Copy link
Contributor

Choose a reason for hiding this comment

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

Is it okay if we wait until the merger of #77 and fix this also?

[controllers](https://github.com/nephio-project/docs/blob/main/user-guide/controllers.md)
* Learn more about how packages are [transformed](https://github.com/nephio-project/docs/blob/main/install-guide/package-transformations.md)
* Learn more about [deploying helm charts](https://github.com/nephio-project/docs/blob/main/user-guide/docs/helm/README.md) in Nephio
* Learn more about how packages are [transformed]({{< relref "../install-guides/package-transformations.md" >}})
* Learn more about [deploying helm charts]({{< relref "../user-guides/helm/#helm-integration-in-nephio" >}}) in Nephio