apache / linkis-website Goto Github PK

• The two tables are not aligned on the right
• Contributors information display control in one line, too long name interception display part

mainly about how to deploy linkis on k8s

There are many broken links in the linkis website checked by link checker: Link

As can be seen in the .github/action/PR_has_a_valid_issue, some of the codes in this path are redundant.

When someone submits an issue to the website, let a bot reply automatically to the initator of the issue.

Flink Engine Conn is available in Linkis1.0.2, but there is not a flink engineconn usage in linkis-doc I think we should add one.

https://linkis.apache.org/versions/
https://linkis.apache.org/zh-CN/versions/

This problem occurs when you use npm install to install packages. The solution is to use yarn install.

key points:

1. the corresponding k8s workloads of linkis components, and how it works
2. control flow, mainly about how the k8s workloads are deployed
3. data flow, such as the job starting steps

A different representation has been found in the documentation that currently represents the installation and deployment directory of Linkis:

${InstallPath}/conf/*properties
${linkis_home}/conf
${LINKIS_HOME}/lib/linkis-engineconn-plugins

It is recommended to keep it unified and use ${LINKIS_HOME}?

当前表示Linkis的安装部署目录 文档中已发现有不同的表示方式:

${InstallPath}/conf/*properties
${linkis_home}/conf
${LINKIS_HOME}/lib/linkis-engineconn-plugins

建议保持统一 ，统一使用${LINKIS_HOME}?

To fix the typos[computatoin -> computation] of linkis-website repos https://github.com/apache/incubator-linkis-website

The following are outstanding / completed issues:

• Linkis website checks, This PR #283 solved this issue;
• The website Github icon need to be changed, This PR #342 solved this issue;
• The Linkis website needs to add a github action to check whether the linkis website link is available, This PR #341 solved this issue;
• [Bug]docs version page display not centered, This PR #301 solved this issue;
• [Improvement] The team page needs to add a committer presentation, This PR #346 solved this issue;
• Branch merge issue, This PR #343 solved this issue;
• Some links in the linkis website need to fix, This PR #348 solved this issue;
• Some parts of the front-end compilation doc are redundant, This PR #365 fixed the issue.
• [Improvement] Unification of usage specifications for representing Linkis installation directories, this PR #363 fixed the issue.
• [Improvement][Verify the candidate Version] add the compilation verification of the web, this PR #358 fixed the issue.
• [Improvement] The top bar doc version display style need to optimize, this PR #362 fixed the issue.
• [Improvement] Add a Blessing Wall page to the website, this PR #373 fixed the issue.
• [Improvement] The website need to add an auto comment bot, This PR #378 fixed this issue.
• [Improvement] The website requires an auto closing issue bot, This PR #392 fixed this issue.
• The team page of the website is not adapted to the mobile terminal, This PR #400 fixed this issue.
• Some github action codes in the website repository are redundant, This PR #398 fixed the issue.
• Can the same docs version support multiple routing path, this PR #428 fixed the issue.

Some links on the linkis website have been broken.

compile on spark 3.2.1, error log as following:

[INFO] Using incremental compilation using Mixed compile order
[INFO] Compiler bridge file: /home/scm/.sbt/1.0/zinc/org.scala-sbt/org.scala-sbt-compiler-bridge_2.12-1.3.1-bin_2.12.15__52.0-1.3.1_20191012T045515.jar
[INFO] Compiling 64 Scala sources to /home/scm/comspace/Linkis/linkis-engineconn-plugins/engineconn-plugins/spark/target/classes ...
[ERROR] [Error] /home/scm/comspace/Linkis/linkis-engineconn-plugins/engineconn-plugins/spark/src/main/scala/org/apache/linkis/engineplugin/spark/metadata/SparkSQLHistoryParser.scala:218: value child is not a member of org.apache.spark.sql.execution.command.CreateViewCommand
[ERROR] one error found
[INFO] ------------------------------------------------------------------------
[INFO] Reactor Summary for linkis-engineconn-plugins 1.1.2:
[INFO]
[INFO] linkis-engineconn-plugin-core ...................... SUCCESS [ 10.304 s]
[INFO] linkis-engineconn-plugin-cache ..................... SUCCESS [ 1.152 s]
[INFO] linkis-engineconn-plugin-loader .................... SUCCESS [ 5.736 s]
[INFO] linkis-engineconn-plugin-server .................... SUCCESS [ 54.806 s]
[INFO] linkis-engineplugin-hive ........................... SUCCESS [ 13.256 s]
[INFO] linkis-engineplugin-spark .......................... FAILURE [ 12.919 s]
[INFO] linkis-engineplugin-python ......................... SKIPPED
[INFO] linkis-engineplugin-openlookeng .................... SKIPPED
[INFO] linkis-engineplugin-io_file ........................ SKIPPED
[INFO] linkis-engineplugin-shell .......................... SKIPPED
[INFO] linkis-engineplugin-pipeline ....................... SKIPPED
[INFO] linkis-engineplugin-jdbc ........................... SKIPPED
[INFO] linkis-engineconn-plugins .......................... SKIPPED
[INFO] linkis-engineconn-plugin-flink ..................... SKIPPED
[INFO] linkis-engineplugin-sqoop .......................... SKIPPED
[INFO] ------------------------------------------------------------------------
[INFO] BUILD FAILURE
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 01:38 min
[INFO] Finished at: 2022-05-31T08:48:28+08:00
[INFO] ------------------------------------------------------------------------
[ERROR] Failed to execute goal net.alchim31.maven:scala-maven-plugin:4.3.0:compile (scala-compile-first) on project linkis-engineplugin-spark: Execution scala-compile-first of goal net.alchim31.maven:scala-maven-plugin:4.3.0:compile failed.: CompileFailed -> [Help 1]
[ERROR]

Presto engine combined with linkis to use documentation

• Add "how to compile" or "how to package" guidelines, which are convenient for users to compile intuitively and quickly finished
• Add "verify the releases" guidelines finished
• Table layout adjustment, try to avoid the crowded list content displayed
  

engine_conn_history.md，engine_conn_metrics.md，content_service_cleanup.md document translation

It should be highlighted when clicked,such as

Some documents have text errors and need to be corrected
Incorrect or invalid jump links in the document need to be adjusted.etc.

English document is located at https://github.com/apache/incubator-linkis-website/tree/dev/docs
Chinese document is located at https://github.com/apache/incubator-linkis-website/tree/dev/i18n/zh-CN/docusaurus-plugin-content-docss

Welcome everyone to participate in this work!

还有一些文档没有对应的英文文档，需要翻译成英文。

【英文文档位于】 https://github.com/apache/incubator-linkis-website/tree/dev/docs
【中文文档位于】 https://github.com/apache/incubator-linkis-website/tree/dev/i18n/zh-CN/docusaurus-plugin-content-docss

欢迎大家参与到这项工作中来!

Branch asf-staging of the linkis website repository of the linkis website should be automatically synchronized with branch asf-stage on a regular basis.

Some documents have text errors and need to be corrected
Incorrect or invalid jump links in the document need to be adjusted.etc.

English document is located at https://github.com/apache/incubator-linkis-website/tree/dev/docs
Chinese document is located at https://github.com/apache/incubator-linkis-website/tree/dev/i18n/zh-CN/docusaurus-plugin-content-docss

Welcome everyone to participate in this work!

部分文件存在文字错误，需要更正
文档中如果存在不正确或无效的跳转链接，需要调整为正确的链接地址等

【英文文档位于】 https://github.com/apache/incubator-linkis-website/tree/dev/docs
【中文文档位于】 https://github.com/apache/incubator-linkis-website/tree/dev/i18n/zh-CN/docusaurus-plugin-content-docss

欢迎大家能够参与到这项工作中来!

Presto engine combined with linkis to use documentation

I hope it can be modified to be the same as this website:
https://eventmesh.apache.org/

There are some text errors in engine_conn_plugin_installation.md and need to be corrected

Used to record errors on the official website

• typo
• link error
• information display error
• display content errors
• etcd.

用于记录官网细小错误点 如

• 错字/拼写错误
• 链接错误
• 信息显示错误
• 显示内容错误
• .....等等

The specification of the title of the document sidebar needs to be consistent，It is better to organize a specification
文档侧边栏的标题规范需要保持统一，最好可以整理一个侧边栏标题规范，放到官网规范文档中 https://linkis.apache.org/zh-CN/community/how-to-contribute-to-website/#3-%E8%A7%84%E8%8C%83

when we want to execute the npm install under the root directory of the website repo,
the error log will be
`
npm notice Run npm install -g [email protected] to update!
npm notice
npm ERR! code ETIMEDOUT
npm ERR! syscall connect
npm ERR! errno ETIMEDOUT
npm ERR! network request to http://10.107.103.115:8001/yallist/download/yallist-4.0.0.tgz failed, reason: connect ETIMEDOUT 10.107.103.115:8001
npm ERR! network This is a problem related to network connectivity.
npm ERR! network In most cases you are behind a proxy or have bad network settings.
npm ERR! network
npm ERR! network If you are behind a proxy, please make sure that the
npm ERR! network 'proxy' config is set properly. See: 'npm help config'

npm ERR! A complete log of this run can be found in:

after check the dev code, there is some fixed ip in package-lock.json. which cannot be connected. not sure if we can change to domain name to let everyone can download . or i have missed sth .

"@types/json-schema": { "version": "7.0.9", "resolved": "http://10.107.103.115:8001/@types/json-schema/download/@types/json-schema-7.0.9.tgz", "integrity": "sha1-l+3JA36gw4WFMgsolk3eOznkZg0=" }
`

When someone comment on an issue, if it is not in English, translate his/her comments into English.

1 .The community QQ group is no longer maintained, and the related QR code entry is removed
2. About Linkis compile use ./mvnw to replace mvn

社区QQ群不再维护，关闭QQ群二维码入口
有关于Linkis项目的编译，统一使用 ./mvnw 替换掉 mvn（可以在命令上一行加些说明 ）

    # 你可以使用你本地的[mvn]命令，或则在win cmd下 使用[mvnw.cmd] 替换 [./mvnw]
    ./mvnw -N  install

key point:

1. tools, such as kind
2. test steps

Add the git action of the scheduled task to synchronize the asf-staging branch to the asf-site branch code

After the current pr is merged, it will be automatically compiled by npm and pushed to the asf-staging branch (asf-staging corresponds to the resource branch of the test domain name https://linkis.staged.apache.org/)
git action adds timed tasks such as automatically syncing the asf-satging branch to the asf-site branch every 12 hours (asf-site corresponds to the resource branch of the official domain name https://linkis.apache.org/)

增加定时任务的git action 同步asf-staging分支到 asf-site分支代码

当前pr 被合并后 ，会自动进行npm编译推送到asf-staging分支(asf-staging对应测试域名https://linkis.staged.apache.org/ 的资源分支)
git action 增加定时任务 如每12个小时自动将 asf-satging分支同步到asf-site分支（asf-site对应正式域名https://linkis.apache.org/ 的资源分支）

As can be shown in the following image, the top bar doc version doesn't display directly:

It is better to change like this:

actually we donnot have ${LINKIS_HOME}/bin/install.sh ,the install.sh should be under the installation package, we can fix it.

bin under linkis home

bin installation package

fix spelling mistake in build.md

The following list is the latest newbie tasks (keep up to date). If you are participating in an open source project for the first time, it is recommended to choose one of the following tasks to practice. The first task is used to familiarize yourself with the submission process and feel the friendliness of the community. If you are interested in a task, Please leave a message, for example, I am interested in implementing this task, please submit a PR in 2 weeks if you leave the message. If more than 2 weeks, other contributors are welcome to do it.

😊 The current development branch is dev, please submit pr to this branch

For the claim of the issue task:

At present, github cannot directly assign issues to those who do not have permission to write the project repository. Only allow issues to be assigned to people who have commented on the issue. https://github.blog/2019-06-25-assign-issues-to-issue-commenters/

😊 For students who want to claim the linkis issue task and do not have warehouse write permission, they can comment under the corresponding issue. Then the administrator can assign it to you

Before submitting a PR, please read the How to Contribute Guide to the Official Website

以下是新手任务列表（持续更新中）。如果您是第一次参加开源项目，建议您选择以下任务之一进行练习。第一项任务是熟悉提交过程，感受社区的友好。如果您对某项任务感兴趣，请留言，例如，我对执行此任务感兴趣，如果您留言，请在2周内提交PR。如果超过2周，欢迎其他贡献者参与。如果有任何问题可以在下方留言，解决issue过程中的任何开发或则其他问题，社区同学会协助解决。

😊 当前开发分支为dev，请提交pr至此分支

对于issue任务的认领:

目前github对于没有项目仓库写权限的人员，没法直接分配issue。只允许将issue分配给在该issue下评论过的人。 https://github.blog/2019-06-25-assign-issues-to-issue-commenters/

😊 对于想认领linkis的issue任务，又没有仓库写权限的同学，可以在【对应的issue下】评论（如:I want to fix this issues，you can assign it to me）， 然后管理员就可以分配指定给你

提交 PR 前请阅读如何参与官网贡献指南

【官网贡献指引视频 】https://www.bilibili.com/video/BV1qr4y1s7pv?share_source=copy_web
【社区贡献入门指引 PPT】 https://github.com/apache/incubator-linkis-website/blob/dev/resource/Apache%20Linkis%20(Incubating)%20Community%20Contribution%20Getting%20Started%20Guide.pdf

TODO list

Here are some easy-to-fix issues or feature:

• #269
• #268
• #267
• #264
• #257
• #297
• #744

As shown in the above figure, users may confused by detailed configuration.

Maturity Assessment for Linkis

Feel free to discuss and leave your comment.

As show in https://whimsy.apache.org/pods/project/linkis
the linkis website with some problems and needs to be fixed
You can refer to the websites of other projects https://whimsy.apache.org/pods/check/uri

The naming of some resource files/folders does not meet the established naming specificationand needs to be modified and adjusted

Specification Document : https://github.com/apache/incubator-linkis-website/blob/master/README.md#3-specification

Everyone is welcome to participate in this work!

文件的命名需要修改以满足命名规范

一些资源文件/文件夹的命名不满足制定的命名规范，需要修改调整

命名规范 : https://github.com/apache/incubator-linkis-website/blob/master/README.md#3-specification

欢迎大家能够参与到这项工作中来!

key points:

1. build images with maven
2. clarify about the mysql driver
3. add distribution on-demand, such as spark/flink/hive. etc.

When someone submits PR and associates issue, the robot will automatically close issue when PR is merged.

Search returns nothing, May be cause by upgrade docusaurus/theme-search-algolia

To fix the typos[mutiple -> multiple] of linkis-website repos https://github.com/apache/incubator-linkis-website

Originally posted by @casionone in apache/linkis#3862 (comment)

Doc of https://linkis.apache.org/community/how-to-verify/
add the compilation verification of the web code source

https://linkis.apache.org/zh-CN/docs/latest/introduction

The project is now integrated in DSS

该项目现在集成在DSS 项目中，需要调整
调整方式待定

Show the blessings of contributors to linkis.