From 5e2d40960c05d5590ef487b4c6172bc9d661911b Mon Sep 17 00:00:00 2001 From: All-The-Best-for Date: Wed, 30 Oct 2024 00:25:22 +0800 Subject: [PATCH] [feat] HertzBeat Official Template Marketplace [#1792] --- home/docs/help/template_marketplace.md | 70 +++++++++++++------------- 1 file changed, 34 insertions(+), 36 deletions(-) diff --git a/home/docs/help/template_marketplace.md b/home/docs/help/template_marketplace.md index 4693cabd009..19031690e1f 100644 --- a/home/docs/help/template_marketplace.md +++ b/home/docs/help/template_marketplace.md @@ -1,6 +1,6 @@ --- -id: template_marketplace -title: Template Marketplace +id: template_marketplace +title: Template Marketplace sidebar_label: Template Marketplace --- @@ -21,14 +21,14 @@ sidebar_label: Template Marketplace 2. **Filtering by category: currently divided into six categories** > **📋Todo:** develop tag function, subdivided within the category, such as database monitoring template can be divided into MySQL, Oracle, etc. - + ![search-category.png](template-marketplace-img/search-category.png) 3. **Fuzzy search by Title** ![search-name.png](template-marketplace-img/search-name.png) -4. **Hover window function: download the latest version, view details, favorite/unfavorite** +4. **Hover window function: download the latest version, view details, favorite/un-favorite** > Show if the user has favorites after logging in @@ -47,7 +47,7 @@ sidebar_label: Template Marketplace 1. **Info: Summary information, detailed information and other information** > **📋Todo:** Upgrade to MarkDown format - + ![img.png](template-marketplace-img/detail-info.png) 2. **Version: Historical version download, sharing and basic information display** @@ -64,61 +64,58 @@ sidebar_label: Template Marketplace 4. **Download** - > The latest version can be downloaded directly from the list hover window - > - > The latest version can also be downloaded directly from the template detail page - > - > The historical version can be downloaded from the version page - + > The latest version can be downloaded directly from the list hover window. + > The latest version can also be downloaded directly from the template detail page. + > The historical version can be downloaded from the version page. + ![img.png](template-marketplace-img/download.png) 5. **Share** - > Template details page to share the latest version - > - >Version page to share historical versions - > - > Sharing will automatically copy the sharing URL to the clipboard, and the person being shared can download the file via that URL - + > Template details page to share the latest version. + > Version page to share historical versions. + > Sharing will automatically copy the sharing URL to the clipboard, and the person being shared can download the file via that URL + > > **📋Todo:** Shared template detail page is accessed through the URL of the shared template, and the shared person is free to choose whether to download or not. ![img.png](template-marketplace-img/share.png) - ### User Center 💡 User availability - > Provide asset management, collection management and upload function - + > Provide asset management, collection management and upload function +> > **📋Todo:** Overview page, notification page, user settings page 1. **Asset: Manage all templates uploaded by user themselves** - - > Provides the ability to download the latest version and view details + > Provides the ability to download the latest version and view details + > > **📋Todo:** Function to update template information ![img_1.png](template-marketplace-img/user-center-asset.png) + ![img.png](template-marketplace-img/asset-detail.png) 2. **Version Upgrade** > The user defines the new version number under this template family, updates the version information, and uploads the latest version of the file - + ![img.png](template-marketplace-img/asset-upgrade.png) 3. **Star** ![img.png](template-marketplace-img/user-center-star.png) + ![img.png](template-marketplace-img/user-center-star-detail.png) 4. **Upload** - > Create a new template series and upload the first version of the file - + > Create a new template series and upload the first version of the file + > > Fill in the template name, select the template category, fill in the description information and version information, and upload files - + ![img.png](template-marketplace-img/user-center-upload.png) ### Sign Up & Login @@ -127,8 +124,8 @@ sidebar_label: Template Marketplace 1. **Sign up** - > Usernames can be duplicated, but email addresses are unique - + > Usernames can be duplicated, but email addresses are unique + > > **📋Todo:** Captcha function, email verification function ![img.png](template-marketplace-img/sign-up.png) @@ -142,13 +139,14 @@ sidebar_label: Template Marketplace ## Development Steps > Download `template-marketplace/hertzbeat-template-hub` and `template-marketplace/hertzbeat-template-hub-web-app` projects respectively - > - > The front-end project in accordance with README.md directly start - > - > The back-end project steps: - > 1. Run the `sql` script in the `template-marketplace/hertzbeat-template-hub/sql` to create database tables - > 2. Install MinIO - > 3. Config `MySQL` and `MinIO` in the application.yml - > 4. Start the back-end project + + The front-end project in accordance with README.md directly start + + The back-end project steps: + + 1. Run the `sql` script in the `template-marketplace/hertzbeat-template-hub/sql` to create database tables + 2. Install MinIO + 3. Config `MySQL` and `MinIO` in the `application.yml` + 4. Start the back-end project Other issues can be fed back through the communication group ISSUE!