incubator-devlake-website
incubator-devlake-website copied to clipboard
[Doc][QA Domain & Customize Plugin] Add documentation for QA domain and CSV import feature
📚 Documentation Scope
This documentation update covers:
- The addition of the
QAdomain in DevLake's domain layer, including new entities such asQaProject,QaTestCase,QaApi, andQaTestCaseExecution. - The new CSV import functionality for the
QAdomain via theCustomizeplugin, with endpoints under/plugins/customize/csvfiles/{csvfilename}.csv.
Relevant sections: Domain Layer documentation, Customize Plugin documentation, CSV Import Examples.
✏️ Describe the Change
We need to add:
-
QA Domain Layer Documentation
- Describe the purpose of the
QAdomain (test management and metrics). - Define the core entities (
QaProject,QaTestCase,QaApi,QaTestCaseExecution) with field explanations. - Explain the relationships between entities (e.g., a test case belongs to a project, may link to an API).
- Describe the purpose of the
-
Customize Plugin CSV Import Documentation
- Introduce new CSV endpoints:
-
POST /plugins/customize/csvfiles/qa_test_cases.csv -
POST /plugins/customize/csvfiles/qa_test_case_executions.csv -
POST /plugins/customize/csvfiles/qa_apis.csv
-
- Provide example CSV file formats and sample data.
- Explain how projects (
QaProject) are created automatically duringqa_test_casesimport based onqa_project_idandqa_project_name.
- Introduce new CSV endpoints:
-
Examples Section
- Show examples of uploading CSV files to the Customize plugin.
- Show an example mapping between MeterSphere raw data and the domain layer after import.
🖼️ Screenshots
N/A (new documentation pages and example CSV files will be added).
➕ Additional context
This update supports the new feature request to extend DevLake's capabilities for QA/test management data analysis by ingesting external CSV data. It follows the standard for domain design abstraction and CSV ingestion already used by existing domain layers like issues and CICD.
https://github.com/apache/incubator-devlake/issues/8393