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 78eeba80cc update license.md (#572)
78eeba80cc is described below
commit 78eeba80cccc9b3ac97285888324a97ff5c489e7
Author: 成彬彬 <[email protected]>
AuthorDate: Sun Nov 13 21:46:27 2022 +0800
update license.md (#572)
---
community/development-specification/license.md | 45 ++++++++++++++-----
.../current/development-specification/license.md | 50 ++++++++++++++++------
2 files changed, 71 insertions(+), 24 deletions(-)
diff --git a/community/development-specification/license.md
b/community/development-specification/license.md
index 00c052f85f..5e3c993b7f 100644
--- a/community/development-specification/license.md
+++ b/community/development-specification/license.md
@@ -10,18 +10,41 @@ The open source projects under the ASF (Apache Foundation)
have extremely strict
This article will explain the ASF-License and how to avoid the license risk
when participating in the Linkis project development.
## License file directory description
+
+License related can be divided into 3 parts
+- The main scenarios that need to be paid attention to are: in the project
source code, the resources are directly included in the project (such as the
direct use of video files, sample files, code JAVA of other projects,
additions, icons, audio sources) and other files, and modifications made on the
basis )
+- The packaging of the project will be packaged and released. The main
scenarios that need to be paid attention to are: the running and installation
dependencies of the dependent jar packages in the dependencies, and the pom,
that is, the packaging of the dependencies, will be packaged in
+- The situation that the material installation package of the management
console needs to be paid attention to: the additional dependency packages that
are dependent on the front-end web are configured through linkweb/package.json
+
[Linkis source code](https://github.com/apache/incubator-linkis) The directory
related to the license is as follows
```shell script
-# in the outermost directory
+# the outermost directory starts
+
+├── LICENSE //LICENSE of the project source code Some files without asf
header or the introduction of external resources need to be marked here
+├── NOTICE //The NOTICE of the project source code generally does not change
+├── licenses //Introduction of third-party component licenses at the project
source level
+│ └── LICENSE-py4j-0.10.9.5-src.txt
+├── linkis-dist
+│ └── release-docs
+│ ├── LICENSE //Summary of license information of the third-party jar
packages that depend on the compiled installation package
+│ ├── licenses //Details of the license information corresponding to
the third-party jar package dependent on the compiled installation package
+│ │ ├── LICENSE-log4j-api.txt
+│ │ ├── LICENSE-log4j-core.txt
+│ │ ├── LICENSE-log4j-jul.txt
+│ │ ├── LICENSE-xxxx.txt
+│ └── NOTICE //A summary of NOTICE of dependent third-party jar
packages in the compiled installation package
+├── linkis-web
+ └── release-docs
+ ├── LICENSE //LICENSE information summary of the third-party npm
dependencies of the front-end web compilation and installation package
+ ├── licenses //The license information corresponding to the
third-party npm dependencies of the front-end web compilation and installation
package is detailed
+ │ ├── LICENSE-vuedraggable.txt
+ │ ├── LICENSE-vue-i18n.txt
+ │ ├── LICENSE-vue.txt
+ │ ├── LICENSE-vuescroll.txt
+ │ └── LICENSE-xxxx.txt
+ └── NOTICE //A summary of NOTICE dependent on third-party npm for
front-end web compilation and installation packages
+
-|-- LICENSE //LICENSE of the project source code
-|-- LICENSE-binary //LICENSE of binary package
-|-- LICENSE-binary-ui //LICENSE of the front-end web compilation package
-|-- NOTICE //NOTICE of project source code
-|-- NOTICE-binary // NOTICE of binary package
-|-- NOTICE-binary-ui //NOTICE of front-end web binary package
-|-- licenses-binary The detailed dependent license file of the binary package
-|-- licenses-binary-ui //The license file that the front-end web compilation
package depends on in detail
````
@@ -72,8 +95,8 @@ We build a license-check script for our own project to ensure
that we can avoid
When we need to add new Jars or other external resources, we need to follow
these steps:
* Add the jar name + version you need in
tool/dependencies/known-dependencies.txt.
-* Add relevant license information in LICENSE/LICENSE-binary/LICENSE-binary-ui
(depending on the actual situation).
-* Append the relevant NOTICE file to NOTICE/NOTICE-binary/NOTICE-binary-ui
(determined according to the actual situation). This file must be consistent
with the NOTICE file in the code version repository of the dependencies.
+* Add relevant license information in linkis-web/release-docs/LICENSE
(depending on the actual situation).
+* Append the relevant NOTICE file to linkis-web/release-docs/NOTICE
(determined according to the actual situation). This file must be consistent
with the NOTICE file in the code version repository of the dependencies.
:::caution Note
If the scenario is to remove, then the corresponding reverse operation of the
above steps needs to remove the corresponding LICENSE/NOTICE content in the
corresponding file. In short, it is necessary to ensure that these files are
consistent with the data of the actual source code/compiled package
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs-community/current/development-specification/license.md
b/i18n/zh-CN/docusaurus-plugin-content-docs-community/current/development-specification/license.md
index 25b7a3d527..1096650ee1 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs-community/current/development-specification/license.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs-community/current/development-specification/license.md
@@ -10,18 +10,42 @@ ASF(Apache基金会)下的开源项目，对于License有着极其严苛的要
本文将为您讲解ASF—License以及参与 Linkis 项目开发时如何规避掉License风险。
## License 文件目录说明
+
+licence相关的可以划分为3部分
+- 源码级别 主要需要关注的场景是： 在项目工程源码中，直接引入第三方资源（如
直接使用了某个其他项目的代码JAVA文件，新增了文本、css、js、图片、图标、音视频等文件，以及在第三方基础上做的修改）
+- 项目的安装物料包 主要需要关注的场景是： 依赖的第三方jar包的运行态依赖，pom 配置中 通过dependency依赖引入
即最后编译打包会被打包到发布的安装包中的
+- 管理台的安装物料包 主要需要关注的场景是：前端web编译依赖的第三方npm依赖包 通过linkis-web/package.json 配置引入
+
+
[Linkis源码](https://github.com/apache/incubator-linkis)涉及到license的目录如下
-```shell script
-#位于最外层的目录下
-|-- LICENSE //项目源码的LICENSE
-|-- LICENSE-binary //二进制包的LICENSE
-|-- LICENSE-binary-ui //前端web编译包的LICENSE
-|-- NOTICE //项目源码的NOTICE
-|-- NOTICE-binary //二进制包的NOTICE
-|-- NOTICE-binary-ui //前端web二进制包的NOTICE
-|-- licenses-binary 二进制包的详细依赖的license文件
-|-- licenses-binary-ui //前端web编译包详细依赖的license文件
+```shell script
+# 最外层目录开始
+
+├── LICENSE //项目源码的LICENSE 一些没有asf header的文件或则引入外部资源需要在这里标明
+├── NOTICE //项目源码的NOTICE 一般不会变动
+├── licenses //项目源码级别引入第三方组件license 说明
+│ └── LICENSE-py4j-0.10.9.5-src.txt
+├── linkis-dist
+│ └── release-docs
+│ ├── LICENSE //编译的安装包中依赖的第三方jar包的license信息汇总
+│ ├── licenses //编译的安装包中依赖的第三方jar包对应的license信息详细
+│ │ ├── LICENSE-log4j-api.txt
+│ │ ├── LICENSE-log4j-core.txt
+│ │ ├── LICENSE-log4j-jul.txt
+│ │ ├── LICENSE-xxxx.txt
+│ └── NOTICE //编译的安装包中依赖的第三方jar包的NOTICE 汇总
+├── linkis-web
+ └── release-docs
+ ├── LICENSE //前端web编译安装包第三方npm依赖的LICENSE信息汇总
+ ├── licenses //前端web编译安装包第三方npm依赖对应的license信息详细
+ │ ├── LICENSE-vuedraggable.txt
+ │ ├── LICENSE-vue-i18n.txt
+ │ ├── LICENSE-vue.txt
+ │ ├── LICENSE-vuescroll.txt
+ │ └── LICENSE-xxxx.txt
+ └── NOTICE //前端web编译安装包第三方npm依赖的NOTICE 汇总
+
```
@@ -72,12 +96,12 @@ copyright notice that is included in or attached to the
work.
当我们需要添加新的Jar或其他外部资源的时候，我们需要按照以下步骤：
* 在 tool/dependencies/known-dependencies.txt中添加你所需要的jar名称+版本。
-* 在 LICENSE/LICENSE-binary/LICENSE-binary-ui（根据实际情况决定）中添加相关的license信息。
-* 在
NOTICE/NOTICE-binary/NOTICE-binary-ui（根据实际情况决定）中追加相关的NOTICE文件，此文件请务必和依赖项的代码版本仓库中的NOTICE文件一致。
+* 在 linkis-web/release-docs/LICENSE（根据实际情况决定）中添加相关的license信息。
+* 在
linkis-web/release-docs/NOTICE（根据实际情况决定）中追加相关的NOTICE文件，此文件请务必和依赖项的代码版本仓库中的NOTICE文件一致。
:::caution 注意
如果是移除的场景，则对应的上述步骤的反向操作，需要在对应的文件中移除相应的LICENSE/NOTICE内容，总之需要保证这几个文件与实际源码/编译包的数据保持一致
-- known-dependencies.txt
+- tool/dependencies/known-dependencies.txt
- LICENSE/LICENSE-binary/LICENSE-binary-ui
- NOTICE/NOTICE-binary/NOTICE-binary-ui
:::
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
