https://github.com/superedge/website

SuperEdge website and documentation
https://github.com/superedge/website

Last synced: about 1 month ago
JSON representation

SuperEdge website and documentation

• Host: GitHub
• URL: https://github.com/superedge/website
• Owner: superedge
• License: cc-by-4.0
• Created: 2021-06-15T03:57:24.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2022-04-19T17:16:53.000Z (over 2 years ago)
• Last Synced: 2023-03-03T21:03:38.556Z (almost 2 years ago)
• Language: HTML
• Size: 3.14 MB
• Stars: 2
• Watchers: 10
• Forks: 8
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Codeowners: CODEOWNERS

Awesome Lists containing this project

README

        
# SuperEdge Documentation

This repo contains the assets used to build the SuperEdge website at https://superedge.io.

## Running and developing the website locally

### 1. To run the site locally, you need to install:

* [npm](https://www.npmjs.com/get-npm)

* [Hugo (extended version)](https://gohugo.io/getting-started/installing) with the version specified in the [netlify.toml](netlify.toml)

### 2. Clone this repo and its submodules

```console

git clone https://github.com/superedge/website.git

cd website

npm install

make load-submodule

```

### 3. Serve the site locally

```console

make serve

```

Open http://localhost:1313 in your browser to see the running site. Any code change to the site content will immediately be updated to the running site.

## How to modify the documentation

Most of the documentation lives in:

* Chinese: `content/zh/docs`

* English: `content/en/docs`

### Other assets

* **Attached images** in the docs should be put in `static/images/docs/`.

* **Sample yaml config** should be stored as yaml file in `content//examples/` and reference using `codenew` shortcut.

For example,

```

{{< codenew file="serviceGroup/edge-health-admission.yaml" >}}

```

## Deployments and PR previews

Commits to the `main` branch will be automatically published to the https://superedge.io by Netlify.

PR triggers Netlify to build a preview site and return the site link on the PR page.