40034abe01
|
3 years ago | |
|---|---|---|
| .. | ||
| _static | ||
| _templates | ||
| content | 3 years ago | |
| Dockerfile | ||
| Makefile | ||
| README.md | ||
| build_docs.sh | ||
| conf.py | 3 years ago | |
| docs_site.sh | ||
| index.md | ||
| make.bat | ||
README.md
This README gives an overview of how to build the documentation of Flink CDC.
Build the site locally
Make sure you have installed Docker and started it on you local environment.
From the directory of this module (docs), use the following command to start the site.
./docs_site.sh start
Then the site will run and can be viewed at http://localhost:8001, any update on the docs will be shown in the site without restarting.
Of course, you can use the following command to stop the site.
./docs_site.sh stop