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
He Wang a10e07fd36
[cdc-connector][oceanbase] Add option for obcdc extra configs (#2543)
This closes #2543.
1 year ago
..
_static [hotfix][docs] Fix the abnormal display of pictures (#2513) 1 year ago
_templates [build] Update the copyright year to 2023 (#2205) 2 years ago
content [cdc-connector][oceanbase] Add option for obcdc extra configs (#2543) 1 year ago
site [build] Update the copyright year to 2023 (#2205) 2 years ago
Dockerfile [hotfix][doc] Fix doc site with 404 (#2322) 2 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 [hotfix][doc] Fix doc site with 404 (#2322) 2 years ago
conf.py [build] Update the copyright year to 2023 (#2205) 2 years ago
docs_site.sh [build] Update the copyright year to 2023 (#2205) 2 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