migrate dlink docs from dinky-website to this repo'docs (DataLinkDC#761)

.gitignore

@@ -33,4 +33,11 @@ dlink-web/node_modules/*
 dlink-web/node/*
 dlink-web/dist/*
 dlink-admin/src/main/resources/static/*
-dependency-reduced-pom.xml
+dependency-reduced-pom.xml
+
+# Dinky Docs gitignore
+docs/.docusaurus
+docs/node_modules
+docs/.cache-loader
+docs/package-lock.json
+docs/build

docs/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

docs/README.md

@@ -0,0 +1,151 @@
+## Dinky  Website
+
+该项目保留了用于构建 Dinky 官方网站的所有资源，服务于 http://www.dlink.top/
+
+## 条件
+
+Dinky 网站基于 Docusaurus 。如果您的 Docusaurus 版本低于 2.0.0，请升级到 2.0.0。另请确保您的Node版本为 14.x。
+
+### 安装
+
+```
+$ yarn / npm i
+```
+
+### 本地启动
+
+```
+$ yarn start / npm run start / npx docusaurus start [--port 3111 ] [--host localhost ] 默认端口为 3000
+```
+
+此命令启动本地开发服务器并打开浏览器窗口。大多数更改都会实时预览，而无需重新启动服务器。
+
+### 编译
+
+```
+$ yarn build / npm run build
+```
+
+此命令将静态内容生成到 build 目录中，并且可以使用任何静态内容托管服务提供服务。
+
+## 如何提交一个  PR
+
+确保您有提交问题以跟踪 PR：https://github.com/DataLinkDC/dinky-website/issues
+
+- 不要使用 `git add .` 提交所有更改；
+- 只需推送您更改的文件，例如：
+  - `*.md`
+  - `config.js`
+- 提交 PR 到 **dev** 分支；
+
+## 添加新文档
+
+### 为文档添加新文章
+
+- 在当前路径下的 docs 下添加新的 `.md` 文件
+- 在本地运行 serve 验证文章是否正确显示
+- 发送拉取的请求包含 `*.md`
+
+### 为文档添加新版本
+
+- 修改 docs 中的文档，然后在本地运行 `yarn start`或者 `npm run start`
+- 将新添加的文档从 docs 复制到 versioned_docs 的新版本
+- 修改最后一个所有版本在 `/src/pages/version/index.js`
+
+### 添加博客/分享/实践
+
+  - 只需在根目录下的 `blog` 文件夹下添加新的 `.md` 文件 , 需要注意点如下:
+
+  ```text
+     1. 文件命名格式: `年-月-日-title.md`  切记不可以中文命名 命名尽量见名知意 言简意赅
+     2. 例如: `2022-01-01-hello-world.md`
+     3. 文件名称中的日期将自动解析为改文章的创建日期
+  ```
+ - 博客作者的作者信息可以添加到 `authors.yml` 中 ,格式如下:
+
+  ```text
+  aiwenmo: # 博客作者
+      name: aiwenmo # 博客作者名称
+      title: Dinky 项目发起人 # 博客作者标题
+      url: https://github.com/DataLinkDC/dlink # 博客作者主页
+      image_url: http://www.aiwenmo.com/dinky/docs/dinky_logo.svg # 博客作者头像
+  ```
+
+  - 作者信息定义完成后 即可在 `md` 文件顶部引用 eg: `authors: [aiwenmo]` 
+  - 文档头部信息引用模板:
+
+  ```text
+  # 注意 此处定义信息 必须从文档的顶部(第一行)开始
+  --- 
+  slug: first-blog-post  # 博客 slug 等于 文件名中自动解析的 title
+  title: First Blog Post # 标题 可覆盖文件名称中的自动解析的 title
+  authors: [dinky] # 可引用  authors.yml 定义的作者名称 可以多个作者 逗号隔开
+  tags: [Hudi, Flink]  # 文档所属标签 可选项(可多个)
+  ---  
+
+  注意 : 如果不像在 authors.yml 中定义作者信息 模板如下:
+  --- 
+  slug: first-blog-post  # 博客 slug 等于文件名
+  title: First Blog Post # 博客 标题 
+  authors: 
+       name: aiwenmo # 博客作者名称
+       title: Dinky 项目发起人 # 博客作者标题
+       url: https://github.com/DataLinkDC/dlink # 博客作者主页
+       image_url: http://www.aiwenmo.com/dinky/docs/dinky_logo.svg # 博客作者头像
+  tags: [Hudi, Flink]  # 文档所属标签 可选项(可多个且无需定义)
+  --- 
+  ```
+  为了更方便得提交您的文章 博客相关的格式如下:
+```text
+---
+slug: long-blog-post 
+title: Blog Title
+authors: [aiwenmo]
+tags: [hello, docusaurus]
+---
+
+输入简短的该博客描述信息
+
+<!--truncate--> # 注意:此处用于主页截断 上述的描述信息 以达到首页的博客列表limit 此行必须写
+
+正文
+
+```
+
+**注意:** 如您的博客文章中含有图片 请遵守以下规范:
+- 文章内图片统一放置在 `blog/blog_img/{文件的title名称 命名新的文件夹}/`
+- 图片需要更名: 不要使用默认 `img.png` 根据其用途命名, 不能有中文 , 尽量见名知意
+- 文档内引用图片 请使用相对路径 eg: `![图片名称](./blog_img/{文件的title名称 命名新的文件夹}/demo.png)`
+
+
+
+## 文档目录结构
+
+```html
+blog --博客分享 
+docs --最新文档
+download --下载
+i18n -- 国际化
+src --源码
+  - components --组件
+      - HomepageFeature --首页特性
+  - css --css
+  - pages  -- all version 页面管理 
+     - versions --版本管理   
+static --静态文件
+  - img --官网图片
+versioned_docs --历史版本文档
+  - version-0.6.0 --版本0.6.0文档
+  - version-0.6.1 --版本0.6.1文档
+version_sidebars --历史版本文档侧边栏
+  - version-0.6.0-sidebars.json --历史版本文档侧边栏
+  - version-0.6.1-sidebars.json --历史版本文档侧边栏
+babel.config.js --babel配置文件
+docusaurus.config.js --docusaurus配置文件
+package.json --项目配置文件
+README.md --项目介绍
+sidebars.js --侧边栏配置文件
+sidebarsDevelopment.js --侧边栏配置文件
+versions.json --版本配置文件
+
+```