Skip to content
This repository has been archived by the owner on Feb 22, 2020. It is now read-only.

Commit

Permalink
docs: fix doc path
Browse files Browse the repository at this point in the history
  • Loading branch information
hanhxiao committed Jul 26, 2019
1 parent 6ff3079 commit 5b52ce4
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 4 deletions.
4 changes: 2 additions & 2 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -67,13 +67,13 @@ Highlights
:maxdepth: 2
:caption: Contributing

CONTRIBUTING.md
chapter/CONTRIBUTING.md

.. toctree::
:maxdepth: 1
:caption: Changelog

CHANGELOG.md
chapter/CHANGELOG.md


Tutorials
Expand Down
11 changes: 9 additions & 2 deletions docs/tutorial/gnes-yaml-specifications.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,12 @@

YAML is everywhere. This is pretty much your impression when first trying GNES. Understanding the YAML config is therefore extremely important to use GNES.

GNES itself only requires two types of YAML config:
-
Essentially, GNES only requires two types of YAML config:
- GNES-compose YAML
- Component-wise YAML

The docker-compose YAML config and Kubernetes config generated from GNES Board or `$ gnes compose` command is not a part of this tutorial. Interested readers are welcome to read their YAML specification respectively.

## GNES-compose YAML

GNES-compose YAML defines

0 comments on commit 5b52ce4

Please sign in to comment.