Skip to content

README.md

Latest commit

 

History

History
95 lines (64 loc) · 3.06 KB

README.md

File metadata and controls

95 lines (64 loc) · 3.06 KB

TapData Documentation

Welcome to TapData Cloud documentation!

This repository stores all the source files of TapData Cloud 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.

What is TapData?

TapData is a live data platform designed to connect data silos and provide fresh data to the downstream operational applications & operational analytics.

🎮 Try it for free

Contributing

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.

  1. Clone repository.

    git clone https://github.com/tapdata/docs-en.git

  2. 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

  3. Modify or add your documentations.

  4. Run a local development server to preview (http://localhost:3000/) your changes as you edit the files.

    npm run start

  5. (Optional) Check broken links.

    cd tools
# Quick Check
npm run check-links:quick

# or Detailed Check
npm run check-links

  6. Create a pull request.

Project structure

├── docs		       # Docs for the current version
│   ├── cloud		       # TapData Cloud Docs(Chinese language)
│   │   ├── images	       # Screen shots, illustrations for docs
│   │   ├── ………… 
├── 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
└── i18n		       # TapData Cloud Docs(English language), dir: i18n/docusaurus-plugin-content-docs/current

Contact

We have a few channels for contact: