keon94 commented on code in PR #340:
URL:
https://github.com/apache/incubator-devlake-website/pull/340#discussion_r1041483021
##########
docs/DataModels/SystemTables.md:
##########
@@ -0,0 +1,28 @@
+---
+title: "System Tables"
+description: >
+ Stores DevLake's own entities
+sidebar_position: 4
+---
+
+## Summary
+
+This document describes Apache DevLake's data models of its own entities.
+
+
+## Use Cases
+
+1. As a user, you can check `_devlake_blueprints` and `_devlake_pipelines`
when failing to collect data via DevLake's blueprint.
+2. As a contributor, you can check these tables to debug task concurrency or
data migration features.
+
+
+## Data Models
+
+These tables start with a prefix `_devlake`. Unlike raw or tool data tables,
DevLake only contains one set of system tables. The naming convension of these
tables is `_raw_{plugin}_{entity}`, such as
Review Comment:
Let's add "These tables are used and managed by the Devlake framework."
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
