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
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.
master
release-3.2
release-3.3
release-3.1
release-3.0
release-2.4
release-2.3
release-2.2
release-2.1
release-2.0
release-1.4
release-1.3
release-1.2
release-1.1
release-1.0
release-3.3.0
release-3.3.0-rc1
release-3.2.1
release-3.2.1-rc1
release-3.2.0
release-3.2.0-rc1
release-3.2.0-rc0
release-3.1.1
release-3.1.1-rc0
release-3.1.0
release-3.1.0-rc3
release-3.1.0-rc2
release-3.1.0-rc1
release-3.0.1
release-3.0.0
release-3.0.0-rc2
release-3.0.0-rc1
release-2.4.2
release-2.4.1
release-2.4.0
release-2.3.0
release-2.2.1
release-2.2.0
release-2.1.1
release-2.1.0
release-2.0.2
release-2.0.1
release-2.0.0
release-1.1.0
release-1.0.0
release-1.2.0
release-1.3.0
release-1.4.0
rm
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'f2c81c7d08'
${ noResults }
flink-cdc-connectors/docs
History
PengFei Li f2c0a03269
[pipeline-connector][starrocks][docs] Fix the pictures do not display (#2860) 		1 year ago
..
_static [3.0][docs] Add tutorial for mysql to starrocks pipeline (#2841) 1 year ago
_templates [build] Update the copyright year to 2023 (#2205) 2 years ago
content [pipeline-connector][starrocks][docs] Fix the pictures do not display (#2860) 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 [3.0][docs] Add documents for MySql pipeline connector (#2827) 1 year 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