chore: update and reorganize (#137)

* chore: update and reorganize * chore: update and reorganize * chore: rename configuration * chore: reorganize intrudction * chore: reorganize intrudction * chore: reorganize settings * chore: reorganize faq * chore: reorganize developer * chore: reorganize developer and devops * chore: reorganize developer and devops * chore: update readme * chore(release): 0.6.0
ArcBlock · Apr 21, 2022 · be9c2e6 · be9c2e6
1 parent 3d01734
commit be9c2e6
Show file tree

Hide file tree

Showing 309 changed files with 522 additions and 897 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,7 @@
+## 0.6.0 (April 21, 2022)
+
+- chore: reorganize docs
+
 ## 0.5.7 (March 15, 2022)
 
 - doc: update doc for auth service
@@ -86,7 +90,7 @@
 ## 0.2.15 (June 24, 2021)
 
 - update abtnode setup
-- chore: update marketplace doc (#95)
+- chore: update Store doc (#95)
 
 ## 0.2.14 (May 22, 2021)
 
@@ -272,13 +276,13 @@ ci: send notification to slack after deployed
 
 ## 0.0.10 (August 09, 2020)
 
-- add docs by tigeryu8900
+- add docs by wangshijun
 
 ## 0.0.9 (August 07, 2020)
 
-- add docs by tigeryu8900
-- revise EN docs (mostly grammar fixes) by tigeryu8900
-- [src/index.md](./src/index.md) and [src/index.zh.md](./src/index.zh.md) link fix by tigeryu8900
+- add docs by wangshijun
+- revise EN docs (mostly grammar fixes) by wangshijun
+- [src/index.md](./src/index.md) and [src/index.zh.md](./src/index.zh.md) link fix by wangshijun
 - image path fix
 
 ## 0.0.8 (August 07, 2020)

diff --git a/README.md b/README.md
@@ -26,40 +26,89 @@ make run
 ```
 
 ### Tips
-When you use Apple silicon, you may hit some issues, [see](https://github.com/ArcBlock/abtnode-docs/issues/126)
 
+When you use Apple silicon, you may hit some issues, [see](https://github.com/ArcBlock/abtnode-docs/issues/126)
 
 ## Table of Contents
 
-- [Introduction](./src/introduction)
-  - [Blocklet Server Overview](./src/introduction/abtnode-overview)
-  - [Blocklet Server Setup](./src/introduction/abtnode-setup)
-  - [Blocklet Server Access](./src/introduction/abtnode-access)
-- [Blocklet Marketplace](./src/marketplace)
-  - [Find and install blocklet](./src/marketplace/find-and-install)
-  - [Upgrade/downgrade blocklet](./src/marketplace/upgrade-downgrade)
-- [Blocklet Management](./src/blocklet)
-  - [Basic Operations](./src/blocklet/basic-operations)
-  - [Blocklet Environments](./src/blocklet/environments)
-  - [Core Blocklets](./src/blocklet/core-blocklets)
-- [Router](./src/router)
-  - [What is Router?](./src/router/what-is-router)
-  - [Basic Router Usage](./src/router/basic-usage)
-- [Production Deployment](./src/deployment)
-  - [Production Best Practice](./src/deployment/best-practice)
-  - [Deploy with AWS AMI](./src/deployment/form-aws-ami)
-  - [Run behind Reverse Proxy](./src/deployment/behind-reverse-proxy)
-- [Misc](./src/misc)
-  - [Node Settings](./src/misc/node-settings)
-  - [Member Management](./src/misc/member-management)
-  - [GraphQL Console](./src/misc/graphql-console)
-- [Developer Guide](./src/developer)
-  - [Node Configuration](./src/developer/configuration)
-  - [Storage Structure](./src/developer/storage-structure)
-  - [Blocklet Specification](./src/developer/blocklet-spec)
-  - [Create Static Blocklets](./src/developer/static-blocklets)
-  - [Create DApp Blocklets](./src/developer/dapp-blocklets)
-  - [Blocklet Hooks](./src/developer/blocklet-hooks)
-  - [Bundle Blocklets](./src/developer/bundle-blocklets)
-  - [Publish Blocklets](./src/developer/publish-blocklets)
-  - [Blocklet Registry](./src/developer/blocklet-registry)
+- [x] Introduction
+  - [x] Blocklet Server Overview
+  - [x] Blocklet Server Setup
+  - [x] Blocklet Server Access
+- [x] Blocklet Store
+  - [x] What is Store?
+  - [ ] Launch Blocklets
+  - [ ] Setup Blocklets
+- [ ] Blocklet Management
+  - [x] Basic Operations
+  - [ ] Domains & URLs
+  - [ ] Components
+  - [ ] Members
+  - [ ] Passports
+  - [x] Configuration
+- Team
+  - [x] Members
+  - [ ] Passports
+- Settings
+  - [ ] Basic Settings
+  - [ ] Access Keys
+  - [ ] Domains & URLs
+    - [ ] What is Router?
+    - [ ] Basic Router Usage
+  - [ ] SSL Certificates
+  - [ ] Integrations
+  - [ ] About
+- [ ] DevOps Guide
+  - [ ] Setup Blocklet Server
+    - [ ] Production Best Practice
+    - [ ] Deploy with AWS AMI
+    - [ ] Run behind Reverse Proxy
+  - [ ] Backup & Restore
+  - [ ] Blocklet Server CLI
+    - [x] init
+    - [x] start
+    - [x] status
+    - [x] stop
+    - [x] export
+    - [ ] info
+    - [ ] logs
+- [ ] Developer Guide
+  - [ ] Blocklet Spec
+  - [ ] Blocklet Runtime
+  - [ ] Blocklet Lifecycle
+  - [ ] Blocklet Compose
+  - [ ] Blocklet CLI
+    - [ ] config: config blocklet cli
+    - [ ] connect: connect to store and config blocklet cli automatically
+    - [ ] init: from existing
+    - [ ] create: templates, static, dapp
+    - [ ] dev: install/start/remove/reset, test
+    - [ ] exec
+    - [ ] bundle: monorepo, webpack, zip
+    - [ ] version
+    - [ ] upload: bundle
+    - [ ] deploy: local/remote
+    - [ ] meta
+  - [ ] Blocklet Publish
+    - [ ] Logo and favicon
+    - [ ] Title
+    - [ ] Screenshots
+    - [ ] Blocklet.md
+  - [ ] Blocklet SDK
+    - [ ] Auth Service
+    - [ ] Notification
+- [ ] FAQ
+  - [ ] Mirrors for Downloads
+  - [ ] Setup Dev Environment
+  - [ ] Use Blocklet Server with Docker
+
+Other topics that developers should known when develop blocklets.
+
+- [ ] DID Connect
+  - [ ] Overview
+  - [ ] Backend
+  - [ ] Frontend
+- [ ] OCAP SDK
+  - [ ] Getting Started
+  - [ ] Read Data
+  - [ ] Send Transaction
diff --git a/blocklet.yml b/blocklet.yml
@@ -1,5 +1,5 @@
 name: '@arcblock/abtnode-docs'
-version: 0.5.7
+version: 0.6.0
 description: >-
   Blocklet Server Documentation, a help documentation for quickly get started
   with Blocklet Server.
@@ -25,7 +25,7 @@ title: Blocklet Server Docs
 community: 'https://gitter.im/ArcBlock/community'
 documentation: 'https://docs.arcblock.io'
 support: [email protected]
-specVersion: 1.2.3
+specVersion: 1.2.4
 did: z8ia5NLSuFwhPimBJHRdPmp6yx9fG8rcFex4b
 timeout:
   start: 10

diff --git a/docs/trash.md b/docs/trash.md
@@ -59,7 +59,7 @@ ForgeSDK.connect('http://127.0.0.1:8210/api');
   const transferHash = await ForgeSDK.sendTransferTx({
     tx: {
       itx: {
-        // 收款人账户，可以写成你的 ABT Wallet 钱包账户，前提是这个账号 declare 过，不然会报错
+        // 收款人账户，可以写成你的 DID Wallet 钱包账户，前提是这个账号 declare 过，不然会报错
         to: 'z1VPwguZUA26dHrPhsukD9Hbzf6txeJGs7F',
         // 100 --> 转账金额
         // 18 --> 链配置文件里面的 token 精度，默认就是 18

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@arcblock/abtnode-docs",
-  "version": "0.5.7",
+  "version": "0.6.0",
   "description": "Blocklet Server Documentation, a help documentation for quickly get started with Blocklet Server.",
   "main": "index.js",
   "publishConfig": {

diff --git a/src/blocklet/basic-operations/index.md b/src/blocklet/basic-operations/index.md
@@ -1,6 +1,6 @@
 ---
-title: 'Blocklet Management'
-description: 'Blocklet Management'
+title: 'Basic Management'
+description: 'Basic Management'
 keywords: 'blocklet server, blocklet'
 author: 'wangshijun'
 category: ''
@@ -9,7 +9,7 @@ tags:
   - 'blocklet server'
 ---
 
-The *Blocklets Management* page shows all Blocklets installed on the Blocklet Server with the following attributes for each of the Blocklets.
+The *blocklets* page shows all blocklets installed on the blocklet server with the following attributes for each of the blocklets.
 
 1. Name
 2. Access URLs
@@ -31,7 +31,7 @@ interfaces:
 4. API : Specifies a web endpoint for the Blocket provided API.
 5. Service : Specifies a TCP based service.
 
-Developers can add authentication to any of the above URLs. The authentication is provided using the Blocklet Server Teams feature. Additionally, every blocket generates log for every served request. These logs are available as part of the [Logs view](/en/logs).   
+Developers can add authentication to any of the above URLs. The authentication is provided using the Blocklet Server Teams feature. Additionally, every blocket generates log for every served request. These logs are available as part of the [Logs view](/en/logs).
 
 ## Blocklet Operations
 
@@ -54,22 +54,18 @@ The page also presents a search box to lookup Blocklets using their name.
 
 ## Install Blocklet
 
-The Blocklets Management page enables the installation of adhoc Blocklets, which are not available on the Marketplace. Click "Install New Blocklet" button and select "Install from URI".  
+The blocklets page enables the installation of adhoc Blocklets, which are not available on the Store. Click "Install New Blocklet" button and select "Install from URI".
 
 ![](./images/blocklet-install-url.png)
 
 Provide the URL for the required [blocklet.json](https://github.com/blocklet/html-2048-sample/releases/download/1.1.9/blocklet.json). Click next to review the details and install the blocklets.
 
 ## Upgrade Blocklet
 
-The *Blocklets Management* page generates notifications when a new version on an installed Blocklet is available. It is shown with a red uptick next to the Blocklet version.
+The *blocklets* page generates notifications when a new version on an installed Blocklet is available. It is shown with a red uptick next to the Blocklet version.
 
 ![](./images/blocklets-upgrade.png)
 
 You can click the red uptick for the upgrade, it will ask for a confirmation. Once confirmed the Blocklet Server will download and install the new version of the Blocklet.
 
 ![](./images/blocklets-upgrade-confirm.png)
-
-## Downgrade Blocklet
-
-You can not downgrade an installed Blocklet. You have to remove the Blocklet and install it again using the older version.
diff --git a/.../environments/images/blocklet-details.png → ...configuration/images/blocklet-details.png b/.../environments/images/blocklet-details.png → ...configuration/images/blocklet-details.png
diff --git a/...environments/images/blocklet-env-1-en.png → ...onfiguration/images/blocklet-env-1-en.png b/...environments/images/blocklet-env-1-en.png → ...onfiguration/images/blocklet-env-1-en.png
diff --git a/...environments/images/blocklet-env-1-zh.png → ...onfiguration/images/blocklet-env-1-zh.png b/...environments/images/blocklet-env-1-zh.png → ...onfiguration/images/blocklet-env-1-zh.png
diff --git a/...ironments/images/blocklets-access-url.png → ...iguration/images/blocklets-access-url.png b/...ironments/images/blocklets-access-url.png → ...iguration/images/blocklets-access-url.png
diff --git a/.../environments/images/blocklets-config.png → ...configuration/images/blocklets-config.png b/.../environments/images/blocklets-config.png → ...configuration/images/blocklets-config.png
diff --git a/...nvironments/images/blocklets-overview.png → ...nfiguration/images/blocklets-overview.png b/...nvironments/images/blocklets-overview.png → ...nfiguration/images/blocklets-overview.png
diff --git a/src/blocklet/environments/index.md → src/blocklet/configuration/index.md b/src/blocklet/environments/index.md → src/blocklet/configuration/index.md
@@ -2,7 +2,7 @@
 title: 'Configure Blocklet'
 description: 'Configure Blocklet'
 keywords: 'blocklet server, blocklet'
-author: 'tigeryu8900'
+author: 'wangshijun'
 category: ''
 layout: 'documentation'
 tags:
@@ -65,7 +65,7 @@ User defined variables can be updated by clicking the corresponding `pencil`(edi
 
 #### Blocklet Variables
 
-These variables area defined by Blocklet Server to specify an installed blocklet configuration. Most of these variables are immutable. Only a few of these variables can be updated to configure blocklets.   
+These variables area defined by Blocklet Server to specify an installed blocklet configuration. Most of these variables are immutable. Only a few of these variables can be updated to configure blocklets.
 
 1. `BLOCKLET_PORT`: Blocklet port
 2. `BLOCKLET_APP_DIR`: Blocklet application directory

diff --git a/src/blocklet/environments/index.zh.md → src/blocklet/configuration/index.zh.md b/src/blocklet/environments/index.zh.md → src/blocklet/configuration/index.zh.md
diff --git a/src/blocklet/core-blocklets/index.md b/src/blocklet/core-blocklets/index.md
@@ -2,7 +2,7 @@
 title: 'Core Blocklets'
 description: 'Core Blocklets'
 keywords: 'blocklet server, blocklet'
-author: 'tigeryu8900'
+author: 'wangshijun'
 category: ''
 layout: 'documentation'
 tags:
@@ -31,23 +31,23 @@ Blockchain Explorer is a blockchain explorer for the forge-powered blockchains.
 
 Build and deploy forge compatible chains.
 
-### [NFT Marketplace](https://store.blocklet.dev/blocklet/z8iZvmERrWxqReWe1HZmkAaZvFeRpkXutfKDkd)
+### [NFT Store](https://store.blocklet.dev/blocklet/z8iZvmERrWxqReWe1HZmkAaZvFeRpkXutfKDkd)
 
-Decentralised marketplace for buy and sell NFT on ABT Network
+Decentralised Store for buy and sell NFT on ABT Network
 
 ### [NFT Store](https://blocklet.arcblockio.cn/dapp/blockchain-boarding-gate)
 
 Start your NFT online business with a few clicks
 
 ### [Blocklet Store](https://store.blocklet.dev/blocklet/z8ia29UsENBg6tLZUKi2HABj38Cw1LmHZocbQ)
 
-Decentralized Blocklet marketplace to search and view Blocklets and use them with just one command.
+Decentralized Blocklet Store to search and view Blocklets and use them with just one command.
 
 ## DID related
 
 ### [Wallet Playground](https://blocklet.arcblockio.cn/dapp/wallet-playground)
 
 Wallet Playground is a simple Blocklet that demonstrates the full potential of building applications using the following ArcBlock software:
 
-- ABT Wallet and ABT DID protocol
+- DID Wallet and ABT DID protocol
 - Forge, which allows dApps to use publicly verifiable decentralized ledgers
diff --git a/src/blocklet/index.md b/src/blocklet/index.md
@@ -9,10 +9,10 @@ tags:
   - 'blocklet server'
 ---
 
-Previously, you have deployed the Blocklet Server and have installed Blocklets from the [Marketplace](../marketplace). In this section, you will work with Blocklet administration features available in Blocklet Server. You will also look at the various types of Blocklets available with Blocklet Server.
+Previously, you have deployed the Blocklet Server and have installed blocklets from the [store](../store). In this section, you will work with blocklet management features available in Blocklet Server. You will also look at the various types of blocklets available with Blocklet Server.
 
 ## Contents
 
-- [Blocklet Management](./basic-operations)
+- [Basic Management](./basic-operations)
 - [Configure Blocklet](./environments)
 - [Core Blocklets](./core-blocklets)