github-forks
/
flink-cdc-connectors
mirror of https://github.com/ververica/flink-cdc-connectors.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
flink-cdc-connectors/docs
History
Amber Moe dd19da6ff1 [docs][oceanbase] Add Chinese documents for oceanbase-cdc connector() 
This closes .
..
_static [docs] Update the flink cdc picture with supported database vendors.
_templates [build] Use correct year and copyright owner in license files ()
content [docs][oceanbase] Add Chinese documents for oceanbase-cdc connector()
site [build] Use correct year and copyright owner in license files ()
Dockerfile [build] Use tools with stable version in building docs
Makefile [doc] Use sphinx-rtd-theme to manage project documents
README.md [docs] Support build document website locally
build_docs.sh [build] Use correct year and copyright owner in license files ()
conf.py [build] Use correct year and copyright owner in license files ()
docs_site.sh [build] Use correct year and copyright owner in license files ()
index.md clarify ownership to comply with ASF trademark policies ()
make.bat [doc] Use sphinx-rtd-theme to manage project documents

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