You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
flink-cdc-connectors/docs
Hang Ruan 8685fd4027
[docs] Bump connector version to flink 1.15.2 in docs (#1684)
2 years ago
..
_static [build] Use correct year and copyright owner in license files (#1390) 3 years ago
_templates [build] Use correct year and copyright owner in license files (#1390) 3 years ago
content [docs] Bump connector version to flink 1.15.2 in docs (#1684) 2 years ago
site [build] Use correct year and copyright owner in license files (#1390) 3 years ago
Dockerfile [build] Use tools with stable version in building docs 3 years ago
Makefile [doc] Use sphinx-rtd-theme to manage project documents 4 years ago
README.md [docs] Support build document website locally 3 years ago
build_docs.sh [build] Use correct year and copyright owner in license files (#1390) 3 years ago
conf.py [build] Use correct year and copyright owner in license files (#1390) 3 years ago
docs_site.sh [build] Use correct year and copyright owner in license files (#1390) 3 years ago
index.md clarify ownership to comply with ASF trademark policies (#1000) 3 years ago
make.bat [doc] Use sphinx-rtd-theme to manage project documents 4 years ago

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