You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@linkis.apache.org by ca...@apache.org on 2022/07/21 13:52:12 UTC

[incubator-linkis-website] branch dev updated: add site-map and apache-product-name-usage-guide (#454)

This is an automated email from the ASF dual-hosted git repository.

casion pushed a commit to branch dev
in repository https://gitbox.apache.org/repos/asf/incubator-linkis-website.git


The following commit(s) were added to refs/heads/dev by this push:
     new 54f09d663c add site-map and apache-product-name-usage-guide (#454)
54f09d663c is described below

commit 54f09d663ce6a2cfc1fb30f49eadf3adde0c5a6d
Author: Casion <ca...@gmail.com>
AuthorDate: Thu Jul 21 21:52:08 2022 +0800

    add site-map and apache-product-name-usage-guide (#454)
---
 community/apache-product-name-usage-guide.md       |  40 ++++++++
 .../how-to-participate-in-developer-meetings.md    |   2 +-
 community/how-to-release.md                        |   2 +-
 community/site-map.md                              |  65 +++++++++++++
 .../current/apache-product-name-usage-guide.md     |  26 +++++
 .../current/how-to-release.md                      | 107 +++++++++++++++++----
 .../current/site-map.md                            |  65 +++++++++++++
 7 files changed, 286 insertions(+), 21 deletions(-)

diff --git a/community/apache-product-name-usage-guide.md b/community/apache-product-name-usage-guide.md
new file mode 100644
index 0000000000..5509b08ca2
--- /dev/null
+++ b/community/apache-product-name-usage-guide.md
@@ -0,0 +1,40 @@
+---
+title: Apache Product Name Usage Guide
+sidebar_position: 6
+---
+> See https://www.apache.org/foundation/marks/guide for detailed and complete instructions
+
+The first and most prominent mentions must use the full form: "Apache Linkis" of the name for any individual usage (webpage, handout, slides, etc.) Depending on the context and writing style, you should use the full form of the name sufficiently often to ensure that readers clearly understand the association of both the Linkis project and the Linkis software product to the ASF as the parent organization.
+
+Later in each specific document you may use the bare form of the name, i.e. just Linkis, as best suits your writing style.
+
+More specifically:
+
+For use by software vendors or software-related service providers, or when organizations or organization-branded pages are discussing Linkis (or any other Apache brand) in relation to any non-Apache provided software products or services, extra care is required to maintain the independent and vendor-neutral reputation of the Apache brand.
+
+The full form of the name must be used in at least these cases:
+
+- Titles or subtitles, including web page title or description metadata.
+
+- The first and most prominent header elements within any major document section.
+
+- The first and most prominent callout, sidebar, or other types of highlighted blocks of content displayed to the user.
+
+- The first and most prominent uses in running or body text within the document.
+
+- For graphics headers or diagrams, the full form of the name must be clear in the graphic itself where practical; if not, the full form of the name must be used in a prominent caption header, or accompanying explanation of the graphic.
+
+- For video content, in the title and first uses, as well as the last use or any use in credits, must be the full form of the name.
+
+- Proper trademark attributions must also be provided, either in page footers, or in a clearly marked Terms, Legal, Trademarks, or other commonly-named secondary page within a website.
+
+- For use by other kinds of users (i.e. organizations or individuals not primarily providing software products or services somehow related to the Apache software product being discussed):
+
+- For scholarly or academic work: Use the full form in titles, subtitles, the first and most prominent references in headers, callouts, or other highlighted sections, and the first and most prominent references in running or body text. Use of the bare form afterwards is permitted.
+
+- For regularly published media (books, magazines, journalists): ensure the full form is used titles or subtitles, the first and most prominent references in headers, callouts, or other highlighted sections, and the first and most prominent references in running or body text. Otherwise, follow your normal publisher's guidelines for referring to software product names.
+
+- For personal bloggers or individuals: We appreciate the use of the full form of the name in titles and the first and most prominent uses in running or body text.
+
+- Uses of Apache brands in domain names or event names and brands are covered in their own policies.
+
diff --git a/community/how-to-participate-in-developer-meetings.md b/community/how-to-participate-in-developer-meetings.md
index 9f649f0d1d..ea9c10b322 100644
--- a/community/how-to-participate-in-developer-meetings.md
+++ b/community/how-to-participate-in-developer-meetings.md
@@ -1,5 +1,5 @@
 ---
-title: How to participate in developer meetings
+title: How to Participate in Developer Meetings
 sidebar_position: 2.2
 ---
 
diff --git a/community/how-to-release.md b/community/how-to-release.md
index 2fa71f8078..634c9c4137 100644
--- a/community/how-to-release.md
+++ b/community/how-to-release.md
@@ -227,7 +227,7 @@ If the source branch currently developed is dev-1.0.3, version 1.0.3 needs to be
 -Create branch: release-1.0.3-rc1
 -Create tag: release-1.0.3-rc1
 
-Sort out the content description of this change and release, sort by [module][pr_url].
+Sort out the content description of this change and release, sort by \[module]\[pr_url].
 Enter the creation page https://github.com/apache/incubator-linkis/releases/new
 Create a release based on the previous release-1.0.3-rc1 tag, and check `This is a pre-release` to write the release notes.
 
diff --git a/community/site-map.md b/community/site-map.md
new file mode 100644
index 0000000000..6497b463fa
--- /dev/null
+++ b/community/site-map.md
@@ -0,0 +1,65 @@
+---
+title: sitemap
+sidebar_position: 12
+---
+
+## Related Links 
+
+- Successful Graduation Guide https://incubator.apache.org/guides/graduation.html
+
+- Graduation Checklist https://incubator.apache.org/guides/graduation.html#graduation_check_list
+
+- Create an open and diverse community https://incubator.apache.org/guides/graduation.html#creating_an_open_and_diverse_community
+
+- Maturity Model http://community.apache.org/apache-way/apache-project-maturity-model.html
+
+- Use of trademarks https://www.apache.org/foundation/marks/guide Note how to use Apache Linkis and Linkis
+
+- APACHE Project Website Branding Policy https://www.apache.org/foundation/marks/pmcs.html
+
+- Trademark QA questions https://www.apache.org/foundation/marks/faq/#guide
+
+- List of trademarked sites https://www.apache.org/foundation/marks/resources
+
+- Apache logo https://www.apache.org/foundation/press/kit/#poweredby 
+
+- Linkis name application to Jira https://issues.apache.org/jira/projects/PODLINGNAMESEARCH/issues/PODLINGNAMESEARCH-192?filter=allissues
+
+- Podling Name Search Guide https://incubator.apache.org/guides/names.html
+
+- Infrastructure related https://infra.apache.org/
+
+- FAQ for committers https://infra.apache.org/committers.html#mail committer
+
+- Contributor CLA agreement related https://www.apache.org/licenses/contributor-agreements.html
+
+- Incubation and Graduation Project Information https://incubator.apache.org/projects/#graduated
+
+- The incubator homepage https://incubator.apache.org/ has related video sharing and ppt
+
+
+## Linkis related links
+- linkis-logo https://svn.apache.org/repos/asf/comdev/project-logos/originals/
+- Project list https://projects.apache.org/project.html?incubator-linkis
+- Maintain IP Clearance https://svn.apache.org/repos/asf/incubator/public/trunk/content/ip-clearance/
+- Board Reports https://whimsy.apache.org/board/minutes/Linkis.html
+- Linkis name application jira https://issues.apache.org/jira/projects/PODLINGNAMESEARCH/issues/PODLINGNAMESEARCH-192?filter=allissues
+- Project status file https://incubator.apache.org/projects/linkis.html
+- Official website legitimacy check https://whismy.apache.org/pods/project/linkis
+- View ppmc mail and other information https://whhimsy.apache.org/roster/ppmc/linkis
+- project file https://svn.apache.org/repos/asf/incubator/public/trunk/content/projects/linkis.xml
+- podling file https://svn.apache.org/repos/asf/incubator/public/trunk/content/podlings/linkis.yml
+- clutch https://incubator.apache.org/clutch/linkis.html
+
+
+- View submitting users over a period of time
+https://github.com/apache/incubator-linkis/graphs/contributors?from=2021-08-02&to=2022-07-21&type=c
+
+- View closed pr for a certain period of time
+`\[Filters] is:pr is:closed closed:>2021-08-02 `
+https://github.com/apache/incubator-linkis/pulls?q=is%3Apr+is%3Aclosed+closed%3A%3E2021-08-02
+
+
+- View closed issues within a certain period of time
+`\[Filters] is:pr is:closed closed:>2021-08-02 `
+https://github.com/apache/incubator-linkis/issues?q=is%3Aissue+is%3Aclosed+closed%3A%3E2021-08-02
\ No newline at end of file
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs-community/current/apache-product-name-usage-guide.md b/i18n/zh-CN/docusaurus-plugin-content-docs-community/current/apache-product-name-usage-guide.md
new file mode 100644
index 0000000000..a3b3d30fda
--- /dev/null
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs-community/current/apache-product-name-usage-guide.md
@@ -0,0 +1,26 @@
+---
+title: APACHE 产品名称使用指南
+sidebar_position: 12
+---
+> 详细完整说明见 https://www.apache.org/foundation/marks/guide
+
+第一次和最突出的提及必须使用完整形式:名称的“Apache Linkis”用于任何个人用途(网页、讲义、幻灯片等)。
+根据上下文和写作风格,应该频繁的使用完整形式的命名以确保读者清楚地了解 Linkis 项目和 Linkis 软件产品与 ASF 作为母组织的关联。
+然后再后续的每个特定文档中,可以使用最简单的名称形式,即 Linkis,因为它最适合写作风格。
+ 
+进一步来说:对于软件供应商或软件相关服务提供商的使用,或者当组织或组织品牌页面讨论与任何非 Apache 提供的软件产品或服务相关的 Linkis(或任何其他 Apache 品牌)时,
+ 需要格外小心以维护Apache 品牌的独立和供应商中立的声誉。
+ 
+至少在以下情况下必须使用名称的完整形式:
+
+- 标题或副标题,包括网页标题或描述元数据。
+- 任何主要文档部分中的第一个也是最突出的标题元素 
+- 向用户显示的第一个也是最突出的标注、侧边栏或其他类型的突出显示的内容块 
+- 在文档中运行或正文文本中的第一个也是最突出的用途
+- 对于图形标题或图表,名称的完整形式必须在可行的情况下在图形本身中清晰;如果没有,则必须在突出的标题标题或随附的图形说明中使用完整的名称形式
+- 对于视频内容,在标题和第一次使用,以及最后一次使用或在演职员表中的任何使用,必须是名称的完整形式
+- 还必须在页脚或明确标记的条款、法律、商标或网站内的其他常用二级页面中提供正确的商标归属
+- 对于学术或学术工作:在标题、副标题中使用完整形式,在标题、标注或其他突出显示的部分中使用第一个和最突出的引用,在运行或正文中使用第一个和最突出的引用。之后允许使用精简形式 
+- 对于定期出版的媒体(书籍、杂志):确保使用完整形式的标题或副标题,标题、标注或其他突出显示部分中的第一个和最突出的引用,以及运行或正文中的第一个和最突出的引用
+- 对于个人博客作者或个人:赞赏在标题中使用完整的名称形式,以及在运行或正文中的第一个也是最突出的用途
+
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs-community/current/how-to-release.md b/i18n/zh-CN/docusaurus-plugin-content-docs-community/current/how-to-release.md
index 157c188fc9..ccad789fd7 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs-community/current/how-to-release.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs-community/current/how-to-release.md
@@ -140,8 +140,6 @@ gpg:              unchanged: 1
 
 #### 1.5.1 在dev分支中添加公钥到KEYS
 
-用于发布RC版本
-
 ```shell
 $ mkdir -p linkis_svn/dev
 $ cd linkis_svn/dev
@@ -153,16 +151,14 @@ $ cd linkis_svn/dev/linkis
 # 追加你生成的KEY到文件KEYS中, 追加后最好检查一下是否正确
 $ (gpg --list-sigs YOUR_NAME@apache.org && gpg --export --armor YOUR_NAME@apache.org) >> KEYS 
 
-# 如果之前存在KEYS文件,则不需要
-$ svn add KEYS	
+# 第一次提交KEY文件,需要先将KEYS文件加入版本控制   svn add KEYS
+
 #提交到SVN
 $ svn ci -m "add gpg key for YOUR_NAME" 
 ```
 
 #### 1.5.2 在release分支中添加公钥到KEYS
 
-用于发布正式版本
-
 ```shell
 $ mkdir -p linkis_svn/release
 $ cd linkis_svn/release
@@ -173,8 +169,8 @@ $ svn co https://dist.apache.org/repos/dist/release/incubator/linkis
 $ cd  linkis
 # 追加你生成的KEY到文件KEYS中, 追加后最好检查一下是否正确
 $ (gpg --list-sigs YOUR_NAME@apache.org && gpg --export --armor YOUR_NAME@apache.org) >> KEYS 
-# 如果之前存在KEYS文件,则不需要
-$ svn add KEYS	
+
+# 第一次提交KEY文件,需要先将KEYS文件加入版本控制   svn add KEYS	
 #提交到SVN
 $ svn ci -m "add gpg key for YOUR_NAME" 
 ```
@@ -266,9 +262,9 @@ step1 基于待发布的开发分支,创建release-${release_version}-rc分支
 step2 创建新的github release
 
 进入到创建页面 https://github.com/apache/incubator-linkis/releases/new 
-基于之前release-1.1.2-rc1分支创建同名tag,填写标题`Apache Linkis(incubating) Release-1.1.2-Incubating-RC1`,并勾选`This is a pre-release`,将该版本的release notes链接写入
+基于之前`release-1.1.2-rc1`分支创建名为`1.1.2-rc`的tag,填写标题`Apache Linkis(incubating) Release-1.1.2-Incubating-RC1`,并勾选`This is a pre-release`,将该版本的release notes链接写入
 
-![image](https://user-images.githubusercontent.com/7869972/172565676-b04a99b9-ced8-4aaf-a479-1b33979d742a.png)
+ ![image](https://user-images.githubusercontent.com/7869972/180214706-7228e5ae-f810-4e07-80fc-67fcf01688eb.png)
 
 step3 检查
 
@@ -456,8 +452,6 @@ $ for i in *.tar.gz; do echo $i; sha512sum --check  $i.sha512; done
 
 详细验证流程可以参见[验证候选版本](how-to-verify.md)
 
-
-
 ## 3 发布Apache SVN仓库
 
 - Linkis [DEV分支](https://dist.apache.org/repos/dist/dev/incubator/linkis) 用来存储候选版本的源码和二进制等原始物料
@@ -586,11 +580,54 @@ Hello Linkis Community,
         https://cwiki.apache.org/confluence/display/INCUBATOR/Incubator+Release+Checklist
     Steps to validate the release,Please refer to: 
         https://linkis.apache.org/community/how-to-verify
+
 Thanks,
 ${Linkis Release Manager}
 ```
 
-#### 5.1.2 宣布投票结果模板
+#### 5.1.2 关闭投票线程 
+如果投票已达到所需票数后,进行结果统计前,需要直接回复投票邮件,说明关闭本次投票线程
+
+```html
+Hi,
+
+Thanks, everyone, I will close 
+
+this vote thread and the results will be tallied.
+
+Best wishes!
+
+${Linkis Release Manager}
+```
+
+#### 5.1.3 取消投票(如果需要取消) 
+
+如果反馈了一些严重问题,需要修复后,重新发布,则需要取消投票,发布经理需要新起取消投票邮件 并进行说明
+
+```html
+邮件标题:
+[CANCEL][VOTE] Release Apache Linkis (Incubating) ${release_version} ${rc_version}
+
+邮件正文:
+Hello Linkis Community,
+
+    I'm cancelling this vote [投票链接] because of license issues. I'll fix them and start
+    the round 2 vote process.
+    
+    The detail of the modifications are as follows:
+    
+    1. Remove the file xxx
+    2. Removes the files be built from shenyu-dashboard
+    
+    Thanks a lot for all your help.
+
+${Linkis Release Manager}
+```
+
+
+
+#### 5.1.4 宣布投票结果模板
+
 参考示例:[\[RESULT\]\[VOTE\] Release Apache Linkis (Incubating) 1.1.2-RC2](https://lists.apache.org/thread/gh1b1t3cjom8bq9o3xbntbjgrkp0vly3) https://lists.apache.org/thread/gh1b1t3cjom8bq9o3xbntbjgrkp0vly3
 备注:该邮件thread地址,可以通过访问`https://lists.apache.org/list?dev@linkis.apache.org `这个页面查到(注意加载时间可能会比较长),然后选择相应邮件,点击进去后即可生成thread链接;
 ```html
@@ -676,21 +713,53 @@ Hello Incubator Community,
     Steps to validate the release,Please refer to: 
         • https://linkis.apache.org/community/how-to-verify
 
+
 Thanks,
 On behalf of Apache Linkis(Incubating) community
 
 ```
-在投票满足条件,并已结束后,需要简单回复之前投票邮件,表示投票已结束,举例:
-``` html
 
-Hi all:
+#### 5.2.2 关闭投票线程 
+如果投票已达到所需票数后,进行结果统计前,需要直接回复投票邮件,说明关闭本次投票线程
+
+```html
+Hi,
+
+Thanks, everyone, I will close 
+
+this vote thread and the results will be tallied.
+
+Best wishes!
+
+Apache Linkis(Incubating) community
+```
+
+#### 5.2.3 取消投票(如果需要取消) 
+
+如果反馈了一些严重问题,需要修复后,重新发布,则需要取消投票,发布经理需要新起取消投票邮件 并进行说明
+
+```html
+邮件标题:
+[CANCEL][VOTE] Release Apache Linkis (Incubating) ${release_version} ${rc_version}
+
+邮件正文:
+Hello Incubator Community,
 
-With a total of 3 +1 binding votes, 2 +1 non-binding votes, no 0 or -1 votes, I will close the voting email.
+    I'm cancelling this vote [投票链接] because of license issues. I'll fix them and start
+    the round 2 vote process.
+    
+    The detail of the modifications are as follows:
+    
+    1. Remove the file xxx
+    2. Removes the files be built from shenyu-dashboard
+    
+    Thanks a lot for all your help.
 
-Thanks!
+Apache Linkis(Incubating) community
 ```
 
-#### 5.2.2 宣布投票结果模板
+
+#### 5.2.4 宣布投票结果模板
 
 参考示例:[\[RESULT\]\[VOTE\] Release Apache Linkis (Incubating) 1.1.2-RC2](https://lists.apache.org/thread/l6xtpt8g1wxwnbotods11fzd1hkoqx63) https://lists.apache.org/thread/l6xtpt8g1wxwnbotods11fzd1hkoqx63
 ```html
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs-community/current/site-map.md b/i18n/zh-CN/docusaurus-plugin-content-docs-community/current/site-map.md
new file mode 100644
index 0000000000..659d2c7711
--- /dev/null
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs-community/current/site-map.md
@@ -0,0 +1,65 @@
+---
+title: 站点地图
+sidebar_position: 12
+---
+
+## 相关链接 
+
+- 成功毕业指南  https://incubator.apache.org/guides/graduation.html 
+
+- 毕业清单    https://incubator.apache.org/guides/graduation.html#graduation_check_list
+
+- 创建一个开放和多元化的社区  https://incubator.apache.org/guides/graduation.html#creating_an_open_and_diverse_community
+
+- 成熟度模型  http://community.apache.org/apache-way/apache-project-maturity-model.html
+
+- 商标的使用  https://www.apache.org/foundation/marks/guide 需要注意怎么使用Apache Linkis和Linkis 
+
+- Apache 徽标  https://www.apache.org/foundation/press/kit/#poweredby 
+
+- APACHE 项目网站品牌政策 https://www.apache.org/foundation/marks/pmcs.html
+
+- 商标QA问题  https://www.apache.org/foundation/marks/faq/#guide
+
+- 商标站点列表 https://www.apache.org/foundation/marks/resources
+
+- Linkis的名字申请Jira https://issues.apache.org/jira/projects/PODLINGNAMESEARCH/issues/PODLINGNAMESEARCH-192?filter=allissues
+
+- Podling 名称搜索指南 https://incubator.apache.org/guides/names.html 
+
+- 基础设施建设相关  https://infra.apache.org/ 
+
+- 提交者的常见问题 https://infra.apache.org/committers.html#mail  committer 
+
+- 贡献者CLA协议相关  https://www.apache.org/licenses/contributor-agreements.html 
+
+- 孵化和毕业项目信息  https://incubator.apache.org/projects/#graduated
+
+- 孵化器主页  https://incubator.apache.org/ 有相关的视频分享和ppt
+
+
+## Linkis相关的链接 
+- linkis-logo  https://svn.apache.org/repos/asf/comdev/project-logos/originals/
+- 项目列表 https://projects.apache.org/project.html?incubator-linkis
+- 维护IP Clearance https://svn.apache.org/repos/asf/incubator/public/trunk/content/ip-clearance/
+- Board Reports https://whimsy.apache.org/board/minutes/Linkis.html
+- Linkis的名字申请jira  https://issues.apache.org/jira/projects/PODLINGNAMESEARCH/issues/PODLINGNAMESEARCH-192?filter=allissues 
+- 项目状态文件  https://incubator.apache.org/projects/linkis.html
+- 官网合法性检查  https://whimsy.apache.org/pods/project/linkis
+- ppmc 邮件等信息查看 https://whimsy.apache.org/roster/ppmc/linkis
+- project 文件  https://svn.apache.org/repos/asf/incubator/public/trunk/content/projects/linkis.xml 
+- podling 文件 https://svn.apache.org/repos/asf/incubator/public/trunk/content/podlings/linkis.yml
+- clutch  https://incubator.apache.org/clutch/linkis.html
+
+
+- 查看某段时间内的提交用户  
+https://github.com/apache/incubator-linkis/graphs/contributors?from=2021-08-02&to=2022-07-21&type=c
+
+- 查看某段时间内 closed的pr 
+`\[Filters] is:pr is:closed closed:>2021-08-02 `
+https://github.com/apache/incubator-linkis/pulls?q=is%3Apr+is%3Aclosed+closed%3A%3E2021-08-02
+
+
+- 查看某段时间内  close的issue 
+`\[Filters] is:pr is:closed closed:>2021-08-02 `
+https://github.com/apache/incubator-linkis/issues?q=is%3Aissue+is%3Aclosed+closed%3A%3E2021-08-02


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@linkis.apache.org
For additional commands, e-mail: commits-help@linkis.apache.org