Merge pull request #29 from devsapp/gwh/dipper

fix:Inspect template readme and publish
devsapp · Sep 15, 2024 · 52ec9fb · 52ec9fb
2 parents 70b518f + 115cea7
commit 52ec9fb
Show file tree

Hide file tree

Showing 21 changed files with 438 additions and 98 deletions.
diff --git a/.github/workflows/publish_app.yaml b/.github/workflows/publish_app.yaml
@@ -13,6 +13,8 @@ jobs:
   auto-publish:
     runs-on: ubuntu-latest
     steps:
+      - run: git config --global core.symlinks false
+        shell: bash
       - uses: actions/checkout@v2
       - uses: actions/setup-node@v2
         with:

diff --git a/angular/publish.yaml b/angular/publish.yaml
@@ -3,7 +3,7 @@ Type: Project
 Name: start-angular-cap
 Provider:
   - 阿里云
-Version: 0.0.1
+Version: 0.0.2
 Description: 本案例将 Angular 框架示例快速创建并部署到阿里云函数计算 FC 。
 HomePage: https://github.com/devsapp/start-website/tree/dipper/angular
 Organization: 阿里云函数计算（FC）
@@ -15,6 +15,9 @@ Service:
   函数计算:
     Authorities:
       - AliyunFCFullAccess
+  日志服务: 
+    Authorities: 
+      - AliyunFCServerlessDevsRolePolicy
 Parameters:
   type: object
   additionalProperties: false # 不允许增加其他属性

diff --git a/angular/readme.md b/angular/readme.md
@@ -1,3 +1,6 @@
+
+> 注：当前项目为 Serverless Devs 应用，由于应用中会存在需要初始化才可运行的变量（例如应用部署地区、函数名等等），所以**不推荐**直接 Clone 本仓库到本地进行部署或直接复制 s.yaml 使用，**强烈推荐**通过 `s init ${模版名称}` 的方法或应用中心进行初始化，详情可参考[部署 & 体验](#部署--体验) 。
+
 # start-angular-cap 帮助文档
 
 <description>
@@ -18,9 +21,33 @@
 | 服务/业务 |  权限  | 相关文档 |
 | --- |  --- | --- |
 | 函数计算 |  AliyunFCFullAccess | [帮助文档](https://help.aliyun.com/product/2508973.html) [计费文档](https://help.aliyun.com/document_detail/2512928.html) |
+| 日志服务 |  AliyunFCServerlessDevsRolePolicy | [帮助文档](https://help.aliyun.com/zh/sls) [计费文档](https://help.aliyun.com/zh/sls/product-overview/billing) |
 
 </service>
 
+<remark>
+
+
+
+</remark>
+
+<disclaimers>
+
+
+
+</disclaimers>
+
+## 部署 & 体验
+
+<appcenter>
+
+- :fire: 通过 [云原生应用开发平台 CAP](https://devs.console.aliyun.com/applications/create?template=start-angular-cap) ，[![Deploy with Severless Devs](https://img.alicdn.com/imgextra/i1/O1CN01w5RFbX1v45s8TIXPz_!!6000000006118-55-tps-95-28.svg)](https://devs.console.aliyun.com/applications/create?template=start-angular-cap) 该应用。
+
+</appcenter>
+<deploy>
+
+
+</deploy>
 
 ## 案例介绍
 

diff --git a/angular/src/build.yaml b/angular/src/build.yaml
@@ -0,0 +1,9 @@
+start_angular:
+  defaultBuilder:
+    languages:
+      - nodejs20
+    steps:
+      - run: npm install && npm run build
+        path: ./code
+      - run: cp nginx.conf ./dist/angular/browser/nginx.conf
+        path: ./code
diff --git a/angular/src/readme.md b/angular/src/readme.md
@@ -1 +1,76 @@
-../readme.md
+
+> 注：当前项目为 Serverless Devs 应用，由于应用中会存在需要初始化才可运行的变量（例如应用部署地区、函数名等等），所以**不推荐**直接 Clone 本仓库到本地进行部署或直接复制 s.yaml 使用，**强烈推荐**通过 `s init ${模版名称}` 的方法或应用中心进行初始化，详情可参考[部署 & 体验](#部署--体验) 。
+
+# start-angular-cap 帮助文档
+
+<description>
+
+本案例将 Angular 框架示例快速创建并部署到阿里云函数计算 FC 。
+
+</description>
+
+
+## 前期准备
+
+使用该项目，您需要有开通以下服务并拥有对应权限：
+
+<service>
+
+
+
+| 服务/业务 |  权限  | 相关文档 |
+| --- |  --- | --- |
+| 函数计算 |  AliyunFCFullAccess | [帮助文档](https://help.aliyun.com/product/2508973.html) [计费文档](https://help.aliyun.com/document_detail/2512928.html) |
+| 日志服务 |  AliyunFCServerlessDevsRolePolicy | [帮助文档](https://help.aliyun.com/zh/sls) [计费文档](https://help.aliyun.com/zh/sls/product-overview/billing) |
+
+</service>
+
+<remark>
+
+
+
+</remark>
+
+<disclaimers>
+
+
+
+</disclaimers>
+
+## 部署 & 体验
+
+<appcenter>
+
+- :fire: 通过 [云原生应用开发平台 CAP](https://devs.console.aliyun.com/applications/create?template=start-angular-cap) ，[![Deploy with Severless Devs](https://img.alicdn.com/imgextra/i1/O1CN01w5RFbX1v45s8TIXPz_!!6000000006118-55-tps-95-28.svg)](https://devs.console.aliyun.com/applications/create?template=start-angular-cap) 该应用。
+
+</appcenter>
+<deploy>
+
+
+</deploy>
+
+## 案例介绍
+
+<appdetail id="flushContent">
+
+本案例将 Angular 框架示例快速创建并部署到阿里云函数计算 FC 。
+
+Angular 是谷歌开发的一款开源的 web 前端框架，诞生于 2009 年，由 Misko Hevery 等人创建，后为 Google 所收购。是一款优秀的前端 JS 框架，已经被用于 Google 的多款产品当中。
+
+</appdetail>
+
+## 使用流程
+
+<usedetail id="flushContent">
+
+### 查看部署的应用
+本项目案例是 Angular 部署到阿里云 Serverless 平台（函数计算 FC），部署完成之后，您可以看到系统返回给您的案例地址。
+
+此时，打开案例地址，就可以进入 Angular 默认的首页。
+
+</usedetail>
+
+## 注意事项
+
+<matters id="flushContent">
+</matters>
diff --git a/docusaurus/publish.yaml b/docusaurus/publish.yaml
@@ -3,7 +3,7 @@ Type: Project
 Name: start-docusaurus-cap
 Provider:
   - 阿里云
-Version: 0.0.1
+Version: 0.0.2
 Description: 本案例将 Docusaurus ，这一使用者广泛的网站生成器，快速创建并部署到阿里云函数计算 FC 。
 HomePage: https://github.com/devsapp/start-website/tree/dipper/docusaurus
 Organization: 阿里云函数计算（FC）
@@ -16,6 +16,9 @@ Service:
   函数计算:
     Authorities:
       - AliyunFCFullAccess
+  日志服务: 
+    Authorities: 
+      - AliyunFCServerlessDevsRolePolicy
 Parameters:
   type: object
   additionalProperties: false # 不允许增加其他属性

diff --git a/docusaurus/readme.md b/docusaurus/readme.md
@@ -1,3 +1,6 @@
+
+> 注：当前项目为 Serverless Devs 应用，由于应用中会存在需要初始化才可运行的变量（例如应用部署地区、函数名等等），所以**不推荐**直接 Clone 本仓库到本地进行部署或直接复制 s.yaml 使用，**强烈推荐**通过 `s init ${模版名称}` 的方法或应用中心进行初始化，详情可参考[部署 & 体验](#部署--体验) 。
+
 # start-docusaurus-cap 帮助文档
 
 <description>
@@ -21,6 +24,30 @@
 
 </service>
 
+<remark>
+
+
+
+</remark>
+
+<disclaimers>
+
+
+
+</disclaimers>
+
+## 部署 & 体验
+
+<appcenter>
+
+- :fire: 通过 [云原生应用开发平台 CAP](https://devs.console.aliyun.com/applications/create?template=start-docusaurus-cap) ，[![Deploy with Severless Devs](https://img.alicdn.com/imgextra/i1/O1CN01w5RFbX1v45s8TIXPz_!!6000000006118-55-tps-95-28.svg)](https://devs.console.aliyun.com/applications/create?template=start-docusaurus-cap) 该应用。
+
+</appcenter>
+<deploy>
+
+
+</deploy>
+
 ## 案例介绍
 
 <appdetail id="flushContent">
@@ -33,7 +60,7 @@ Docusaurus 是一个为技术文档和博客推出的现代静态网站生成器
 
 Docusaurus 预设了响应式的布局，意味着你的文档网站将会在各种设备上呈现良好的阅读体验。另外，它内置了 Algolia 搜索支持，使得读者能够快速找到关键信息。Docusaurus 的版本控制功能也是一个亮点，它允许开发者轻松管理不同版本的文档，为用户提供多个版本的参考资料。
 
-通过 Serverless 开发平台，您只需要几步，就可以体验 Docusaurus ，并享受 Serverless 架构带来的降本提效的技术红利。
+通过云原生应用开发平台，您只需要几步，就可以体验 Docusaurus ，并享受 Serverless 架构带来的降本提效的技术红利。
 
 </appdetail>
 
@@ -56,4 +83,3 @@ Docusaurus 预设了响应式的布局，意味着你的文档网站将会在各
 
 <matters id="flushContent">
 </matters>
-
diff --git a/docusaurus/src/build.yaml b/docusaurus/src/build.yaml
@@ -0,0 +1,9 @@
+start_docusaurus:
+  defaultBuilder:
+    languages:
+      - nodejs20
+    steps:
+      - run: npm install && npm run build
+        path: ./code
+      - run: cp nginx.conf ./build/nginx.conf
+        path: ./code
diff --git a/docusaurus/src/readme.md b/docusaurus/src/readme.md
@@ -1,36 +1,14 @@
 
 > 注：当前项目为 Serverless Devs 应用，由于应用中会存在需要初始化才可运行的变量（例如应用部署地区、函数名等等），所以**不推荐**直接 Clone 本仓库到本地进行部署或直接复制 s.yaml 使用，**强烈推荐**通过 `s init ${模版名称}` 的方法或应用中心进行初始化，详情可参考[部署 & 体验](#部署--体验) 。
 
-# website-docusaurus-v3 帮助文档
-<p align="center" class="flex justify-center">
-    <a href="https://www.serverless-devs.com" class="ml-1">
-    <img src="http://editor.devsapp.cn/icon?package=website-docusaurus-v3&type=packageType">
-  </a>
-  <a href="http://www.devsapp.cn/details.html?name=website-docusaurus-v3" class="ml-1">
-    <img src="http://editor.devsapp.cn/icon?package=website-docusaurus-v3&type=packageVersion">
-  </a>
-  <a href="http://www.devsapp.cn/details.html?name=website-docusaurus-v3" class="ml-1">
-    <img src="http://editor.devsapp.cn/icon?package=website-docusaurus-v3&type=packageDownload">
-  </a>
-</p>
+# start-docusaurus-cap 帮助文档
 
 <description>
 
 本案例将 Docusaurus ，这一使用者广泛的网站生成器，快速创建并部署到阿里云函数计算 FC 。
 
 </description>
 
-<codeUrl>
-
-
-
-</codeUrl>
-<preview>
-
-
-
-</preview>
-
 
 ## 前期准备
 
@@ -62,16 +40,11 @@
 
 <appcenter>
 
-- :fire: 通过 [Serverless 应用中心](https://fcnext.console.aliyun.com/applications/create?template=website-docusaurus-v3) ，
-  [![Deploy with Severless Devs](https://img.alicdn.com/imgextra/i1/O1CN01w5RFbX1v45s8TIXPz_!!6000000006118-55-tps-95-28.svg)](https://fcnext.console.aliyun.com/applications/create?template=website-docusaurus-v3) 该应用。
+- :fire: 通过 [云原生应用开发平台 CAP](https://devs.console.aliyun.com/applications/create?template=start-docusaurus-cap) ，[![Deploy with Severless Devs](https://img.alicdn.com/imgextra/i1/O1CN01w5RFbX1v45s8TIXPz_!!6000000006118-55-tps-95-28.svg)](https://devs.console.aliyun.com/applications/create?template=start-docusaurus-cap) 该应用。
 
 </appcenter>
 <deploy>
 
-- 通过 [Serverless Devs Cli](https://www.serverless-devs.com/serverless-devs/install) 进行部署：
-  - [安装 Serverless Devs Cli 开发者工具](https://www.serverless-devs.com/serverless-devs/install) ，并进行[授权信息配置](https://docs.serverless-devs.com/fc/config) ；
-  - 初始化项目：`s init website-docusaurus-v3 -d website-docusaurus-v3`
-  - 进入项目，并进行项目部署：`cd website-docusaurus-v3 && s deploy -y`
 
 </deploy>
 
@@ -87,7 +60,7 @@ Docusaurus 是一个为技术文档和博客推出的现代静态网站生成器
 
 Docusaurus 预设了响应式的布局，意味着你的文档网站将会在各种设备上呈现良好的阅读体验。另外，它内置了 Algolia 搜索支持，使得读者能够快速找到关键信息。Docusaurus 的版本控制功能也是一个亮点，它允许开发者轻松管理不同版本的文档，为用户提供多个版本的参考资料。
 
-通过 Serverless 开发平台，您只需要几步，就可以体验 Docusaurus ，并享受 Serverless 架构带来的降本提效的技术红利。
+通过云原生应用开发平台，您只需要几步，就可以体验 Docusaurus ，并享受 Serverless 架构带来的降本提效的技术红利。
 
 </appdetail>
 
@@ -104,29 +77,9 @@ Docusaurus 预设了响应式的布局，意味着你的文档网站将会在各
 
 ![图片alt](https://img.alicdn.com/imgextra/i3/O1CN01SAgalQ1fW09cM1X7i_!!6000000004013-2-tps-1263-664.png)
 
-### 二次开发
-
-您可以通过云端控制台的开发功能进行二次开发。如果您之前是在本地创建的项目案例，也可以在本地项目目录`website-docusaurus-v3`文件夹下，对项目进行二次开发。开发完成后，可以通过`s deploy`进行快速部署。
-
 </usedetail>
 
 ## 注意事项
 
 <matters id="flushContent">
 </matters>
-
-
-<devgroup>
-
-
-## 开发者社区
-
-您如果有关于错误的反馈或者未来的期待，您可以在 [Serverless Devs repo Issues](https://github.com/serverless-devs/serverless-devs/issues) 中进行反馈和交流。如果您想要加入我们的讨论组或者了解 FC 组件的最新动态，您可以通过以下渠道进行：
-
-<p align="center">  
-
-| <img src="https://serverless-article-picture.oss-cn-hangzhou.aliyuncs.com/1635407298906_20211028074819117230.png" width="130px" > | <img src="https://serverless-article-picture.oss-cn-hangzhou.aliyuncs.com/1635407044136_20211028074404326599.png" width="130px" > | <img src="https://serverless-article-picture.oss-cn-hangzhou.aliyuncs.com/1635407252200_20211028074732517533.png" width="130px" > |
-| --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
-| <center>微信公众号：`serverless`</center>                                                                                         | <center>微信小助手：`xiaojiangwh`</center>                                                                                        | <center>钉钉交流群：`33947367`</center>                                                                                           |
-</p>
-</devgroup>
diff --git a/dumi/publish.yaml b/dumi/publish.yaml
@@ -1,7 +1,7 @@
 Edition: 3.0.0
 Type: Project
 Name: start-dumi-cap
-Version: 0.0.1
+Version: 0.0.2
 Provider:
   - 阿里云 # 取值内容参考：https://api.devsapp.cn/v3/common/args.html
 Description: 本案例将 Dumi ，这一为 React 组件和库的开发者量身打造的文档生成器，快速创建并部署到阿里云函数计算 FC 。
@@ -14,6 +14,9 @@ Service: # 使用的服务
   函数计算: # 取值内容参考：https://api.devsapp.cn/v3/common/args.html
     Authorities: #权限描述
       - AliyunFCFullAccess # 所需要的权限
+  日志服务: 
+    Authorities: 
+      - AliyunFCServerlessDevsRolePolicy
 Organization: 阿里云函数计算（FC） # 所属组织
 Effective: Public # 是否公开，取值：Public，Private，Organization
 Parameters: