diff --git a/CHANGELOG.md b/CHANGELOG.md index e36d554..09eeceb 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,7 @@ +## 0.6.1 (四月 27, 2022) + +- fix: correct some url + ## 0.6.0 (April 21, 2022) - chore: reorganize docs diff --git a/blocklet.yml b/blocklet.yml index 1722a0a..7573b2a 100644 --- a/blocklet.yml +++ b/blocklet.yml @@ -1,5 +1,5 @@ name: '@arcblock/abtnode-docs' -version: 0.6.0 +version: 0.6.1 description: >- Blocklet Server Documentation, a help documentation for quickly get started with Blocklet Server. @@ -13,17 +13,17 @@ keywords: - ABTNode repository: type: git - url: 'git+https://github.com/ArcBlock/abtnode-docs.git' + url: git+https://github.com/ArcBlock/abtnode-docs.git author: name: wangshijun email: wangshijun2010@gmail.com - url: 'http://github.com/wangshijun' + url: http://github.com/wangshijun license: MIT -homepage: 'https://github.com/ArcBlock/abtnode-docs-power-user#readme' +homepage: https://github.com/ArcBlock/abtnode-docs-power-user#readme group: static title: Blocklet Server Docs -community: 'https://gitter.im/ArcBlock/community' -documentation: 'https://docs.arcblock.io' +community: https://gitter.im/ArcBlock/community +documentation: https://docs.arcblock.io support: support@arcblock.io specVersion: 1.2.4 did: z8ia5NLSuFwhPimBJHRdPmp6yx9fG8rcFex4b diff --git a/package.json b/package.json index d5232ea..4519ef4 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@arcblock/abtnode-docs", - "version": "0.6.0", + "version": "0.6.1", "description": "Blocklet Server Documentation, a help documentation for quickly get started with Blocklet Server.", "main": "index.js", "publishConfig": { diff --git a/src/blocklet/index.md b/src/blocklet/index.md index 9b2b1f6..af69047 100644 --- a/src/blocklet/index.md +++ b/src/blocklet/index.md @@ -14,5 +14,5 @@ Previously, you have deployed the Blocklet Server and have installed blocklets f ## Contents - [Basic Management](./basic-operations) -- [Configure Blocklet](./environments) +- [Configure Blocklet](./configuration) - [Core Blocklets](./core-blocklets) diff --git a/src/blocklet/index.zh.md b/src/blocklet/index.zh.md index 09f3ac0..5a3d960 100644 --- a/src/blocklet/index.zh.md +++ b/src/blocklet/index.zh.md @@ -12,5 +12,5 @@ tags: 本章将介绍 Blocklet 相关内容，包括: - [基本管理操作](./basic-operations)：介绍了 Blocklet 的启动，停止，重启动操作 -- [环境变量管理](./environments)：介绍了 Blocklet 运行在 Blocklet Server 中的环境变量 +- [环境变量管理](./configuration)：介绍了 Blocklet 运行在 Blocklet Server 中的环境变量 - [核心 Blocklet](./core-blocklets)：介绍了 ArcBlock 官方提供的核心 Blocklet diff --git a/src/config.yml b/src/config.yml index 6289445..4a4c36e 100644 --- a/src/config.yml +++ b/src/config.yml @@ -74,10 +74,10 @@ categories: - /developer/blocklet-cli - /developer/blocklet-spec - /developer/blocklet-sdk - - /developer/auth-service - - /developer/send-notification + - /developer/service-auth + - /developer/service-notification - /developer/composable-blocklet - - /developer/blocklet-hooks + - /developer/blocklet-scripts - /developer/bundle-blocklets - /developer/publish-blocklets locales: diff --git a/src/developer/index.zh.md b/src/developer/index.zh.md index 6b1d98c..509d2ac 100644 --- a/src/developer/index.zh.md +++ b/src/developer/index.zh.md @@ -11,20 +11,15 @@ tags: 如果你是开发者，并且正准备在 Blocklet Server 上进行开发，这一章节为你而准备： -- [下载资源](./resources) -- [配置开发环境](./config-dev-env) -- [Blocklet Server CLI 工具](./abtnode-cli) +- [Blocklet Server CLI 工具](./blocklet-cli) - [Blocklet CLI 工具](./blocklet-cli) -- [创建静态 Blocklet](./static-blocklets) -- [创建 DApp Blocklet](./dapp-blocklets) - [Blocklet 规范](./blocklet-spec) - [Blocklet SDK](./blocklet-sdk) -- [Auth 服务](./auth-service) -- [向 DID Wallet 发送消息](./send-notification) +- [Auth 服务](./service-auth) +- [向 DID Wallet 发送消息](./service-notification) - [使用 DID Connect](./did-connect) - [可组合的 Blocklet](./composable-blocklet) -- [Blocklet 生命周期钩子](./blocklet-hooks) +- [Blocklet 生命周期钩子](./blocklet-scripts) - [打包 Blocklet](./bundle-blocklets) - [发布 Blocklet](./publish-blocklets) -- [在 Codespaces 中开发 Blocklets](./blocklet-codespaces) -- [Docker Registry](./docker-registry) +- [在 Codespaces 中开发 Blocklets](../faq/with-codespaces) diff --git a/src/faq/index.md b/src/faq/index.md new file mode 100644 index 0000000..15253c3 --- /dev/null +++ b/src/faq/index.md @@ -0,0 +1,17 @@ +--- +title: 'FAQ' +description: 'FAQ' +keywords: 'blocklet server, blocklet' +author: 'zhanghan' +category: '' +layout: 'documentation' +tags: + - 'blocklet server' +--- + +There is a list of FAQ: + +- [Setup blocklet dev environment](./setup-env): Instructions on how setup blocklet development environment. +- [Mirrors or Alternative Services](./resources): Use mirrors or alternative services if the defaults does not work. +- [Storage Structure](./storage-structure): Storage Structure. +- [Developing Blocklets with Codespaces](./with-codespaces): Codespaces is an online development environment, hosted by GitHub, that allows you to develop entirely in the cloud. diff --git a/src/faq/index.zh.md b/src/faq/index.zh.md new file mode 100644 index 0000000..76256a2 --- /dev/null +++ b/src/faq/index.zh.md @@ -0,0 +1,16 @@ +--- +title: '节点入门' +description: '节点入门' +keywords: 'blocklet server, blocklet' +author: 'nate' +category: '' +layout: 'documentation' +tags: + - 'blocklet server' +--- + +这个章节，从什么是 Blocklet Server ，到一步步配置启动 Blocklet Server ，完整的带大家熟悉并使用 Blocklet Server 。 + +- [节点功能概览](./overview)：Blocklet Server 功能概览 +- [如何获取 Blocklet Server ](./setup)：从 0 到 1 安装 Blocklet Server 的详细教程 +- [配置并启动 Blocklet Server ](./access)：一步一步详细的介绍如何配置，启动和停止 Blocklet Server diff --git a/src/faq/with-docker/index.md b/src/faq/with-docker/index.md index a4f5e1f..6a96991 100644 --- a/src/faq/with-docker/index.md +++ b/src/faq/with-docker/index.md @@ -26,7 +26,7 @@ The data generated by the node is placed in the /data/abtnode directory in the c ## 3. Registries -We also provide Docker images in the Github Container Registry and AWS ECR, so you can choose the appropriate Registry for your scenario, [details.](../../developer/docker-registry) +We also provide Docker images in the Github Container Registry and AWS ECR, so you can choose the appropriate Registry for your scenario Currently our Docker images are published to 3 registries: diff --git a/src/faq/with-docker/index.zh.md b/src/faq/with-docker/index.zh.md index fdd8bbc..d056dc5 100644 --- a/src/faq/with-docker/index.zh.md +++ b/src/faq/with-docker/index.zh.md @@ -28,7 +28,7 @@ docker run -d -p 80:80 -p 443:443 -v :/data/abtnode arcblo 节点产生的数据放在容器的 `/data/abtnode` 目录下，建议不要把数据放在容器中，保持容器无状态。 -我们还提供了 Github Container Registry 和 AWS ECR 镜像源，大家可以根据自己的场景选择合适的源，[详情.](../../developer/docker-registry) +我们还提供了 Github Container Registry 和 AWS ECR 镜像源，大家可以根据自己的场景选择合适的源 ## 3. 镜像源 diff --git a/src/index.md b/src/index.md index bca44a6..63ab9b3 100644 --- a/src/index.md +++ b/src/index.md @@ -15,51 +15,43 @@ tags: Welcome to Blocklet Server documentation - [Introduction](./introduction) - - [Blocklet Server Overview](./introduction/abtnode-overview) - - [Blocklet Server Setup](./introduction/abtnode-setup) - - [Blocklet Server Access](./introduction/abtnode-access) + - [Blocklet Server Overview](./introduction/overview) + - [Blocklet Server Setup](./introduction/setup) + - [Blocklet Server Access](./introduction/access) - [Blocklet Store](./Store) - [Find and install blocklet](./Store/find-and-install) - [Upgrade/downgrade blocklet](./Store/upgrade-downgrade) - [Blocklet Management](./blocklet) - [Basic Operations](./blocklet/basic-operations) - - [Blocklet Environments](./blocklet/environments) + - [Blocklet Configuration](./blocklet/configuration) - [Core Blocklets](./blocklet/core-blocklets) -- [Router](./router) - - [What is Service Gateway](./router/what-is-router) - - [Service Gateway Usage](./router/basic-usage) - - [Binding domain names to node](./bind-domain-to-node) - - [Certificates for localhost](./router/certificates-for-localhost) +- [Router](./settings/router) + - [What is Service Gateway](./settings/router/what-is-router) + - [Service Gateway Usage](./settings/router/basic-usage) + - [Binding domain names to node](./settings/router/bind-domain-to-node) + - [Certificates for localhost](./settings/router/certificates-for-localhost) - [Logs](./logs) - [Runtime Logs](./logs/blocklet-logs) - - [Lifecycle Logs](./logs/abtnode-logs) -- [Settings](./node-settings) - - [Basic Setting](./node-settings/basic) - - [Access Keys](./ode-settings/access-keys) - - [Integrations](./ode-settings/integrations) + - [Lifecycle Logs](./logs/server-logs) +- [Settings](./settings) + - [Basic Setting](./settings/basic) + - [Access Keys](./settings/access-keys) + - [Integrations](./settings/integrations) - [Production Deployment](./deployment) - [Production Best Practice](./deployment/best-practice) - [Deploy with AWS AMI](./deployment/from-aws-ami) - [Run behind Reverse Proxy](./deployment/behind-reverse-proxy) -- [Misc](./misc) - - [Member Management](./misc/member-management) - - [GraphQL Console](./misc/graphql-console) - - [Generate wildcard HTTPS certificate](./generate-wildcard-https-certificate) - [Developer Guide](./developer) - - [Configuring the development environment](./developer/config-dev-env) - - [Blocklet Server CLI](./developer/abtnode-cli) + - [Blocklet Server CLI](./developer/blocklet-cli) - [Blocklet CLI](./developer/blocklet-cli) - - [Create Static Blocklets](./developer/static-blocklets) - - [Create DApp Blocklets](./developer/dapp-blocklets) - [Blocklet Specification](./developer/blocklet-spec) - [Blocklet SDK](./developer/blocklet-sdk) - - [Configure Auth Service](./developer/auth-service) - - [Send notification to DID Wallet](./developer/send-notification) + - [Configure Auth Service](./developer/service-auth) + - [Send notification to DID Wallet](./developer/service-notification) - [Use DID Connect](./developer/did-connect) - [Composable blocklet](./developer/composable-blocklet) - - [Blocklet Hooks](./developer/blocklet-hooks) + - [Blocklet Scripts](./developer/blocklet-scripts) - [Bundle Blocklets](./developer/bundle-blocklets) - [Publish Blocklets](./developer/publish-blocklets) - [Blocklet Store](./developer/blocklet-store) - - [Developing Blocklets with Codespaces](./developer/blocklet-codespaces) - - [Docker Registry](./developer/docker-registry) + - [Developing Blocklets with Codespaces](./faq/with-codespaces) diff --git a/src/index.zh.md b/src/index.zh.md index efb88ae..e480a7a 100644 --- a/src/index.zh.md +++ b/src/index.zh.md @@ -17,44 +17,36 @@ tags: 欢迎访问 Blocklet Server 的文档 - [介绍](./introduction) - - [节点功能概览](./introduction/abtnode-overview) - - [如何获取 Blocklet Server ](./introduction/abtnode-setup) - - [配置并启动 Blocklet Server ](./introduction/abtnode-access) + - [节点功能概览](./introduction/overview) + - [如何获取 Blocklet Server ](./introduction/setup) + - [配置并启动 Blocklet Server ](./introduction/access) - [Blocklet 市场](./Store) - [查找和安装 Blocklet](./Store/find-and-install) - [升级或降级 Blocklet](./Store/upgrade-downgrade) - [Blocklet 管理](./blocklet) - [基本管理操作](./blocklet/basic-operations) - - [环境变量管理](./blocklet/environments) + - [环境变量管理](./blocklet/configuration) - [核心 Blocklet 介绍](./blocklet/core-blocklets) -- [路由](./router) - - [什么是节点路由](./router/what-is-router) - - [路由基本用法](./router/basic-usage) - - [给节点绑定域名](./bind-domain-to-node) - - [localhost 证书](./router/certificates-for-localhost) +- [路由](./settings/srouter) + - [什么是节点路由](./settings/router/what-is-router) + - [路由基本用法](./settings/router/basic-usage) + - [给节点绑定域名](./settings/router/bind-domain-to-node) + - [localhost 证书](./settings/router/certificates-for-localhost) - [部署指南](./deployment) - [部署最佳实践](./deployment/best-practice) - [在 AWS 上部署](./deployment/from-aws-ami) - [运行在反向代理后面](./deployment/behind-reverse-proxy) -- [其他功能](./misc) - - [节点配置](./misc/node-settings) - - [成员管理](./misc/member-management) - - [GraphQL 控制台](./misc/graphql-console) - [开发者指南](./developer) - - [配置开发环境](./developer/config-dev-env) - - [Blocklet Server CLI 工具](./developer/abtnode-cli) + - [Blocklet Server CLI 工具](./developer/blocklet-cli) - [Blocklet CLI 工具](./developer/blocklet-cli) - - [创建静态 Blocklet](./developer/static-blocklets) - - [创建动态 Blocklet](./developer/dapp-blocklets) - [Blocklet 规范](./developer/blocklet-spec) - [Blocklet SDK](./developer/blocklet-sdk) - - [配置 Auth Service](./developer/auth-service) - - [向 DID Wallet 发送消息](./developer/send-notification) + - [配置 Auth Service](./developer/service-auth) + - [向 DID Wallet 发送消息](./developer/service-notification) - [使用 DID Connect](./developer/did-connect) - [可组合的 Blocklet](./developer/composable-blocklet) - - [Blocklet 生命周期钩子](./developer/blocklet-hooks) + - [Blocklet 生命周期钩子](./developer/blocklet-scripts) - [打包 Blocklet](./developer/bundle-blocklets) - [发布 Blocklet](./developer/publish-blocklets) - [Blocklet 商店](./developer/blocklet-store) - - [在 Codespaces 中开发 Blocklets](./developer/blocklet-codespaces) - - [Docker Registry](./developer/docker-registry) + - [在 Codespaces 中开发 Blocklets](./faq/with-codespaces) diff --git a/src/introduction/overview/index.zh.md b/src/introduction/overview/index.zh.md index 69273a7..d3c74dc 100644 --- a/src/introduction/overview/index.zh.md +++ b/src/introduction/overview/index.zh.md @@ -35,14 +35,4 @@ Blocklet Server 已安装的 Blocklet 列表。 Blocklet Server 的路由配置。详细功能请前往：[路由管理](/zh/router) -## 配置 -![](./images/abtnode-overview-5-zh.png) - -Blocklet Server 配置功能。详细功能请前往：[其他功能](/zh/misc) - -## 试验台 - -![](./images/abtnode-overview-6-zh.png) - -Blocklet Server 提供的 GraphQL 试验台功能页面。详情请前往：[GraphQL 试验台](/zh/misc/graphql-console) diff --git a/src/settings/router/bind-domain-to-node/index.md b/src/settings/router/bind-domain-to-node/index.md index 1f88eca..6670fe7 100644 --- a/src/settings/router/bind-domain-to-node/index.md +++ b/src/settings/router/bind-domain-to-node/index.md @@ -29,7 +29,7 @@ In Blocklet Server, you can bind multiple domains to a site or node itself. All 4. Final Application Routing: Click to deploy URL mapping -This is how to customize the domain name for the node, and you can use it to access the node once it is added. If you need to enable HTTPS, you can refer to: [Bind a domain name to a site and enable SSL](/router/bind-domain-and-ssl). +This is how to customize the domain name for the node, and you can use it to access the node once it is added. If you need to enable HTTPS, you can refer to: [Bind a domain name to a site and enable SSL](/settings/router/bind-domain-and-ssl). ## Attention diff --git a/src/settings/router/bind-domain-to-node/index.zh.md b/src/settings/router/bind-domain-to-node/index.zh.md index af1cc5f..d2f3981 100644 --- a/src/settings/router/bind-domain-to-node/index.zh.md +++ b/src/settings/router/bind-domain-to-node/index.zh.md @@ -29,7 +29,7 @@ Blocklet Server 会为每一个节点分配一个 HTTPS 地址: `https://{public 4. 最后应用路由: 点击部署 URL 映射 -这就是给节点自定义域名的方法，添加完成后就可以使用该域名访问节点了。如果需要启动 HTTPS, 可以参考: [给站点绑定域名以及启用 SSL](/router/bind-domain-and-ssl). +这就是给节点自定义域名的方法，添加完成后就可以使用该域名访问节点了。如果需要启动 HTTPS, 可以参考: [给站点绑定域名以及启用 SSL](/settings/router/bind-domain-and-ssl). ## 注意 diff --git a/version b/version index a918a2a..ee6cdce 100644 --- a/version +++ b/version @@ -1 +1 @@ -0.6.0 +0.6.1