Welcome to Tapdata documentation!
This repository stores all the source files of Tapdata documentation, click to visit: https://docs.tapdata.io
If you find documentation issues, feel free to create an Issue to let us know or directly create a Pull Request to help fix or update it.
Tapdata is a live data platform designed to connect data silos and provide fresh data to the downstream operational applications & operational analytics.
We welcome contributions to help improve the documentation! Here is the steps:
The Tapdata docs are written in Markdown. If you have any questions about the steps blow, please contact us.
-
Clone repository.
git clone https://github.com/tapdata/docs.git
-
Install the dependencies.
Node.js version 16.14 or above (which can be checked by running
node -v).cd docs npm install # or yarn install
-
Modify or add your documentations.
-
Run a local development server to preview (http://localhost:3000/) your changes as you edit the files.
npm run start
-
Create a pull request.
├── docs # Docs for the current version
│ ├── cloud # Tapdata Cloud Docs
│ │ ├── images # Screen shots, illustrations for docs
│ │ ├── …………
│ ├── enterprise # Tapdata Enterprise Docs
│ │ ├── images
│ │ ├── …………
│ └── reuse-content # Reuse content, we can use Markdown files as components and import them elsewhere
├── docusaurus.config.js # A config file containing the site configuration
├── sidebars.js # Sidebar for the current version
├── src # Non-documentation files like pages or custom React components
│ ├── components
│ ├── css
│ └── pages
├── static # Static directory that will be copied into the root of the final build directory
│ └── img
├── versioned_docs # Versioned docs
│ └── version-2.0 # Docs for the 2.0 version
│ ├── cloud
│ ├── enterprise
│ └── reuse-content
├── versioned_sidebars # Sidebar for the 2.0 version
└── versions.json # File to indicate what versions are availableWe have a few channels for contact:
- Slack channel
- @tapdata_daas on Twitter
- Wechat:
