Skip to content

Commit

Permalink
Adding description about docs setup
Browse files Browse the repository at this point in the history
Signed-off-by: Gergely Csatari <gergely.csatari@nokia.com>
  • Loading branch information
CsatariGergely committed Dec 4, 2023
1 parent c914c20 commit 23f88f3
Show file tree
Hide file tree
Showing 3 changed files with 30 additions and 4 deletions.
30 changes: 30 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,33 @@
# Nephio documentation

This repository contains the documentation for the Nephio project.

## Status of the documentation

We are in the middle fo moving the documentation from a GitHub based documentation to a Hugo / Docsy based documentation
site. The content of this repo (especially this) branch will be a bit chaotic during this time.

## How to contribute to the documentation

### 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.
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.)
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`. To install npm simply run
`sudo apt install npm`.
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
--gc --minify`.


# Nephio R1

Welcome to the R1 release of Nephio. Please use the documentation links below to
Expand Down
4 changes: 0 additions & 4 deletions content/en/NephioCrowd.jpeg:Zone.Identifier

This file was deleted.

Binary file removed content/en/featured-background-orig.jpg
Binary file not shown.

0 comments on commit 23f88f3

Please sign in to comment.