History

xliuqq b2e4e615ac use annotation for exposed affinity for dataflow and store info in job's annotation (#4277 ) Signed-off-by: xliuqq <xlzq1992@gmail.com>		2024-08-27 08:15:49 +00:00
..
en	use annotation for exposed affinity for dataflow and store info in job's annotation (#4277 )	2024-08-27 08:15:49 +00:00
media	Add the doc dataset_auto_scaling in Chinese version (#708 )	2021-04-15 15:38:02 +08:00
scripts	Add docs (#70 )	2020-08-25 21:52:26 +08:00
templates	Add docs (#70 )	2020-08-25 21:52:26 +08:00
zh	use annotation for exposed affinity for dataflow and store info in job's annotation (#4277 )	2024-08-27 08:15:49 +00:00
Makefile	Test enhancement (#133 )	2020-09-14 14:34:08 +08:00
README.md	Test enhancement (#133 )	2020-09-14 14:34:08 +08:00
README_zh.md	Test enhancement (#133 )	2020-09-14 14:34:08 +08:00
build.sh	Add docs (#70 )	2020-08-25 21:52:26 +08:00

README.md

Fluid Documentation

This repository stores all the source files of Fluid documentation. That is, the documentation for Fluid.

en: documentation in English
zh: documentation in Chinese

Documentation versions

Currently, we maintain the following versions for Fluid documentation, each with a separate branch:

Branch name	Version description
`master`	the latest development version
`v0.1.0`	v0.1.0

Generate a PDF Documentation

We also provide scripts that helps you generate a PDF documentation conveniently. Before generating,we suppose you have installed Docker so you don't have to install required tools one by one.

Download Required Docker Image
docker pull registry.cn-hangzhou.aliyuncs.com/docs-fluid/doc-build
Start a Container
docker run -it -v <your fluid/docs path>:/data/ fluid/doc-build:0.2.0
Run Makefile
```
cd data
make build
make clean
```