TDengine IDMP Documentation

English | 简体中文

Table of Contents

• TDengine IDMP Documentation
  • Table of Contents
  • 1. Introduction
  • 2. Prepare
    • 2.1 Clone the Repo
    • 2.2 Install mise
    • 2.3 Install Development Tools
    • 2.4 Install Project Dependencies
  • 3. Local Development and Production Deployment
    • 3.1 Start Preview
    • 3.2 Production Build
    • 3.3 Production Deployment
  • 4. Directory Structure
  • 5. Contribution
  • 6. Community Support

---

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

2.1 Clone the Repo

git clone git@github.com:taosdata/tdengine-idmp-docs.git

2.2 Install mise

This project uses mise as the dev tool version manager and just as the command runner. mise is a polyglot dev tool version manager, it reads mise.toml and automatically installs the correct versions of Node.js and pnpm used in this project.

Install mise on Linux/macOS (For other OS, please refer to mise's Getting Started documentation):

curl https://mise.jdx.dev/install.sh | sh

Activate mise in your shell (add to ~/.bashrc, ~/.zshrc, or equivalent):

eval "$(~/.local/bin/mise activate bash)"   # for bash
eval "$(~/.local/bin/mise activate zsh)"    # for zsh

Restart your shell session after modifying your rc file. After restarting, run mise version to verify installation.

2.3 Install Development Tools

Trust current directory and install the dev tools with mise:

cd tdengine-idmp-docs
mise trust
mise install

mise will automatically install the correct Node.js, pnpm versions specified in mise.toml. You can verify with:

node -v
pnpm -v
just -V

2.4 Install Project Dependencies

Run the following command to install all required dependencies:

just 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

just start

• Start English preview

just start-en

Using pnpm directly: If you don't use just, you can run the equivalent commands with pnpm:

# Install dependencies
pnpm install

# Start Chinese preview (default)
pnpm run start:local

# Start English preview
pnpm run start:local:en

# Clear generated assets, caches, and build artifacts
pnpm run clear

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

just build

• Local preview

just serve

Using pnpm directly:

# Build documentation
pnpm build

# Preview the production build locally
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.
• mise.toml: Dev tool version configuration for mise.
• justfile: Task runner recipes for just.
• .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! When contributing, please follow the TDengine IDMP Documentation Writing Guide and submit a Pull Request.

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