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
Leonard Xu c11a98a3cb [hotfix][site] Use Flink with its trademark 3 years ago
..
_static [docs] Add Flink cdc eco-system picture (#623) 3 years ago
_templates [docs] Fix the link of 'edit on github' on site (#578) 3 years ago
content [docs] Adopt the full name 'Apache Flink' with its trademark notice (#988) 3 years ago
site [hotfix][site] Use Flink with its trademark 3 years ago
Dockerfile [build] Use tools with stable version in building docs 4 years ago
Makefile [doc] Use sphinx-rtd-theme to manage project documents 4 years ago
README.md [docs] Support build document website locally 4 years ago
build_docs.sh [docs][site] Introduce static index html for the project website (#961) 3 years ago
conf.py [docs] Adopt the full name 'Apache Flink' with its trademark notice (#988) 3 years ago
docs_site.sh [hotfix][mysql] Fix number overflow in ObjectUtils.minus (#598) 3 years ago
index.md [docs] Adopt the full name 'Apache Flink' with its trademark notice (#988) 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