TDengine IDMP Documentation

English | 简体中文

Table of Contents

1. Introduction
2. Installation
   • 2.1 Install Prerequisite Tools
   • 2.2 Install Project Dependencies
3. Local Development and Production Deployment
   • 3.1 Start Chinese and English Preview
   • 3.2 Production Build
   • 3.3 Production Deployment
4. Directory Structure
5. Contribution
6. Community Support
7. License

---

1. Introduction

TDengine IDMP (Industrial Data Management Platform) is an AI-native IoT and industrial data management platform. It organizes sensor and device data using a classic tree hierarchy, builds a data catalog, provides contextual and standardized data processing, and offers real-time analytics, visualization, event management, and alerting.

This documentation site is built with Docusaurus and provides user guides, development documentation, and related resources for TDengine IDMP.

2. Installation

2.1 Install Prerequisite Tools

This project requires Node.js version 18.0 or above (you can check with node -v). You can use nvm to manage multiple Node versions on a single machine. Then, install pnpm globally via npm:

curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.3/install.sh | bash
source ~/.bashrc
nvm install node
npm install -g pnpm
pnpm --version

2.2 Install Project Dependencies

Navigate to the project repository directory and run the following command to install all required dependencies:

pnpm install  

3. Local Development and Production Deployment

After editing the documentation, you can start the local development server to preview the website.

3.1 Start Preview

The following commands will automatically open a browser window for real-time preview and debugging, suitable for development.

• Start Chinese preview

pnpm start  --host 0.0.0.0

• Start English preview

pnpm start --host 0.0.0.0 --locale en

3.2 Production Build

Use the following command to build static files for production into the build directory. The generated content can be deployed using any static content hosting service. We use Azure Static Web Apps to deploy the IDMP documentation service.

• Build documentation

pnpm build

• Local preview

pnpm serve 

3.3 Production Deployment

After code is merged into the main branch, GitHub Actions will automatically trigger the build and deployment process, deploying the generated static files to Azure Static Web Apps.

4. Directory Structure

• docs/: Markdown source files for documentation.
• src/: Website source code, including pages, components, and styles.
• static/: Static resource files (such as images, documents, etc.).
• build/: Directory for built static files.
• docusaurus.config.js: Website configuration file.
• sidebars.js: Sidebar configuration for documentation.
• i18n/: Internationalization configuration files, supporting multi-language documentation.
• package.json: Project dependencies and script configuration.
• .github/workflows/: GitHub Actions workflow configuration files.
• .docsearch/: Algolia doc search service configuration directory.
• pnpm-lock.yaml: Dependency lock file for the project.
• README-CN.md: Chinese version of the project README.
• README.md: Project README file.

5. Contribution

Contributions to TDengine IDMP documentation are welcome! Please submit a Pull Request or report issues.

6. Community Support

If you encounter any problems while using TDengine IDMP or reading the documentation, please contact us via:

• GitHub Issues
• Official Support Email

7. License