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/08/08 03:58:56 UTC
[incubator-linkis-website] branch dev updated: update ask-for-help.md (#472)
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 198b766911 update ask-for-help.md (#472)
198b766911 is described below
commit 198b7669112dd202a5b8d10596c125c2c9fddc93
Author: Casion <ca...@gmail.com>
AuthorDate: Mon Aug 8 11:58:51 2022 +0800
update ask-for-help.md (#472)
---
community/ask-for-help.md | 64 ----------------
community/how-to-ask-for-help.md | 82 +++++++++++++++++++++
.../{ask-for-help.md => how-to-ask-for-help.md} | 32 +++++---
static/Images-zh/community/dragging-images.gif | Bin 0 -> 726253 bytes
static/Images-zh/community/upload-file.png | Bin 0 -> 56543 bytes
static/Images/community/dragging-images.gif | Bin 0 -> 726253 bytes
static/Images/community/upload-file.png | Bin 0 -> 56543 bytes
7 files changed, 105 insertions(+), 73 deletions(-)
diff --git a/community/ask-for-help.md b/community/ask-for-help.md
deleted file mode 100644
index aa3a63f2bc..0000000000
--- a/community/ask-for-help.md
+++ /dev/null
@@ -1,64 +0,0 @@
----
-title: How to Ask for Help
-sidebar_position: 2.1
----
->This article mainly guides you on how to ask for help from the community. If you have any questions or doubts about the use of the software, you can use the following guidelines to seek help from the community.
-
-
-:::caution note
-Before asking for help, please take a moment to confirm that there are already questions and solutions for class testing in the community.
-:::
-
-<!--
-## Github-Discussion Questions
-Entry: https://github.com/apache/incubator-linkis/discussions
-Question template: https://github.com/apache/incubator-linkis/discussions/2548
-step1: Review the template and notes and requirements https://github.com/apache/incubator-linkis/discussions/2548
-
-step2 Copy the template content
--->
-
-
-## Way1 Github-Issue ask questions (recommended)
-
-### Precautions
-:::caution note
-- Please ask questions in a standardized format, so that the community students can answer them. After asking questions, please continue to pay attention to your questions.
-- Please pay special attention that in addition to screenshots, you also need to paste the <font color="red">log text into </font>. Questions that only have image logs will not be given priority to answer.
-- It is recommended to ask questions in English; if there is an unclear description, you can use a mixture of Chinese and English; translate Chinese into English, and then fill in both Chinese and English into the issue
-- If you want a quick response, please describe the problem in as much detail as possible and attach relevant logs
-:::
-
-### Completion Instructions
-- Entry: https://github.com/apache/incubator-linkis/issues
-
-** Step1: Enter the issue column, click to create issue **
-
-
-
-** Step2: Select \[❓ Ask Questions] **
-
-
-
-** Step3: Fill in your question according to the template **
-
-- Before asking : If you are not familiar with it, you can read the guidelines first to understand the usage and recommended usage specifications
-- Your environmen: Environment and version information If other components are involved, such as: DSS/Qualitis/Exchangis.. Please also fill in
-- Describe your questions: describe your questions
-- Some logs info or acctch file: Please paste the key error log in the code column, paste the text as much as possible, the detailed log or other files, you can drag and drop to upload as an attachment
-
-
-
-
-
-
-## Way2 Email consultation
-
-Email Question Process
-
-- ● Step 1: Subscribe to dev@linkis.apache.org email, click to view the guide [Subscribe to the mailing list](https://linkis.apache.org/zh-CN/community/how-to-subscribe)
-- ● Step 2: Send your question to dev@linkis.apache.org;
-- ● Step 3: After the question is answered, you will be notified by email as soon as possible; and you can communicate via email;
-
-[Example](https://lists.apache.org/thread/x04mhql5vfyc0z41ksfykhppf2fg9o6r): https://lists.apache.org/thread/x04mhql5vfyc0z41ksfykhppf2fg9o6r
-
\ No newline at end of file
diff --git a/community/how-to-ask-for-help.md b/community/how-to-ask-for-help.md
new file mode 100644
index 0000000000..60020e7f60
--- /dev/null
+++ b/community/how-to-ask-for-help.md
@@ -0,0 +1,82 @@
+---
+title: How to Ask for Help
+sidebar_position: 2.1
+---
+---
+title: need help
+sidebar_position: 2.1
+---
+>This article mainly guides you on how to ask for help from the community. If you have any questions or doubts about the use of the software, you can seek help from the community through the following guidelines.
+
+
+:::caution note
+Before asking for help, please take a moment to confirm that there are already questions and solutions for class testing in the community.
+:::
+
+<!--
+## Github-Discussion Questions
+Entry: https://github.com/apache/incubator-linkis/discussions
+Question template: https://github.com/apache/incubator-linkis/discussions/2548
+step1: Review the template and notes and requirements https://github.com/apache/incubator-linkis/discussions/2548
+
+step2 Copy the template content
+-->
+
+
+## Method 1 Github-Issue ask questions (recommended)
+
+### Precautions
+:::caution note
+- Please ask questions in a standardized format, so that the community students can answer them. After asking questions, please continue to pay attention to your questions.
+- Please note that in addition to screenshots, please <font color="red">paste the error log into </font> in text form, only the problem of the picture log will not be given priority to answer
+- It is recommended to ask questions in English. If there is an unclear description, you can use a mixture of Chinese and English; translate Chinese into English, and then fill in both Chinese and English into the issue
+- If you want to get a quick response and solve your problem, please describe the problem and exception log as much as possible. In order to avoid omission and subsequent additions, you can attach <font color="red">all log files</font> as attachments Upload to issue attachment
+- If it is an error during the running phase, please attach a screenshot of the Eureka registry service list
+:::
+
+### Attachment & image upload
+If you want to attach a file attachment, drag and drop it into the comment box. Or click the bar at the bottom of the comment box to browse, select, and add files from your computer.
+
+
+In many browsers you can copy and paste the image directly into the box
+
+
+:::caution note
+The log file should not exceed 25MB
+:::
+
+### Completion Instructions
+- Entry: https://github.com/apache/incubator-linkis/issues
+
+** Step1: Enter the issue column, click to create issue **
+
+
+
+** Step2: Select \[❓ Ask Questions] **
+
+
+
+** Step3: Fill in your question according to the template **
+
+- Before asking : If you are not familiar with it, you can read the guidelines first to understand the usage and recommended usage specifications
+- Your environmen: Environment and version information If other components are involved such as: DSS/Qualitis/Exchangis.. Please also fill in
+- Describe your questions: describe your questions
+- Eureka service list: If it is an error during the running phase, please paste the screenshot of the Eureka registry service list here
+- Some logs info or acctch file: The key error log must be pasted into the code column in text form, the detailed log or other files can be dragged and uploaded as an attachment
+
+
+
+
+
+
+
+## Method 2 Email consultation
+
+Email Question Process
+
+- Step 1: Subscribe to dev@linkis.apache.org emails, click to view the guide [Subscribe to the mailing list](https://linkis.apache.org/zh-CN/community/how-to-subscribe)
+- Step 2: Send your question to dev@linkis.apache.org;
+- Step 3: After the question is answered, you will be notified by email as soon as possible; and you can communicate via email;
+
+[Example](https://lists.apache.org/thread/x04mhql5vfyc0z41ksfykhppf2fg9o6r): https://lists.apache.org/thread/x04mhql5vfyc0z41ksfykhppf2fg9o6r
+
\ No newline at end of file
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs-community/current/ask-for-help.md b/i18n/zh-CN/docusaurus-plugin-content-docs-community/current/how-to-ask-for-help.md
similarity index 54%
rename from i18n/zh-CN/docusaurus-plugin-content-docs-community/current/ask-for-help.md
rename to i18n/zh-CN/docusaurus-plugin-content-docs-community/current/how-to-ask-for-help.md
index 48a878ff02..4bc94888c2 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs-community/current/ask-for-help.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs-community/current/how-to-ask-for-help.md
@@ -3,7 +3,7 @@ title: 需求帮助
sidebar_position: 2.1
---
>本文主要指导大家如何需求社区的帮助，任何关于软件使用的问题或则疑惑，都可以通过以下指引来寻求社区同学的帮助。
->
+
:::caution 注意
寻求帮助前，请先花点时间，确认社区中，是否已有类试的问题和解决方案。
@@ -24,11 +24,23 @@ step2 拷贝模板内容
### 注意事项
:::caution 注意
- 请按格式规范提问，方便社区同学解答，提问后请后续持续关注你的问题
-- 请特别注意除了截图，还需要把<font color="red">日志文字贴入</font>，只有图片日志的问题，不会优先安排回答
-- 建议使用英文提问；如果存在描述不清晰，可以使用中英文混合；把中文翻译为英文，然后中文和英文一同填入到issue中
-- 如果想得到快速相应，请尽可能的详细描述问题以及附上相关的日志
+- 请特别注意除了截图，请把错误日志<font color="red">以文字方式贴入</font>，只有图片日志的问题，不会优先安排解答
+- 建议使用英文提问，如果存在描述不清晰，可以使用中英文混合；把中文翻译为英文，然后中文和英文一同填入到issue中
+- 如果想得到快速相应和解决你的问题，请尽可能的详细描述问题以及异常日志，为了避免遗漏和后续的补充，可以将<font color="red">全部日志文件</font>，作为附件上传到issue附件中
+- 如果是运行阶段的报错，请将Eureka注册中心服务列表截图附上
:::
+### 日志附件&图片的上传
+如果要附加文件附件，请将其拖放到评论框中。或者单击评论框底部的栏来浏览、选择和添加计算机中的文件。
+
+
+在许多浏览器中，您可以将图像直接复制并粘贴到框中
+
+
+:::caution 注意
+日志文件不要超过 25MB
+:::
+
### 填写说明
- 入口:https://github.com/apache/incubator-linkis/issues
@@ -45,20 +57,22 @@ step2 拷贝模板内容
- Before asking :如果不太熟悉，可以先阅读指引，了解使用和推荐的使用规范
- Your environmen: 环境和版本信息 如果涉及其它组件问题 如:DSS/Qualitis/Exchangis.. 也请填写
- Describe your questions: 描述你的问题
-- Some logs info or acctch file: 关键错误日志请务必贴到代码栏中，尽可能贴文字，详细日志或则其它文件，可以拖拽上传作为附件
-
+- Eureka service list：如果是运行阶段的报错，请将Eureka注册中心服务列表截图粘贴到这里
+- Some logs info or acctch file: 关键错误日志请务必以文字形式贴到代码栏中，详细日志或则其它文件，可以拖拽上传作为附件
+
+
## 方式2 邮件咨询
邮件提问流程
-- ● 第一步：订阅dev@linkis.apache.org邮件，点击查看攻略[订阅邮件列表](https://linkis.apache.org/zh-CN/community/how-to-subscribe)
-- ● 第二步：把你的问题发送到dev@linkis.apache.org；
-- ● 第三步：问题收到答复后，会通过邮箱第一时间通知你；并且可以通过邮箱进行交流；
+- 第一步：订阅dev@linkis.apache.org邮件，点击查看攻略[订阅邮件列表](https://linkis.apache.org/zh-CN/community/how-to-subscribe)
+- 第二步：把你的问题发送到dev@linkis.apache.org；
+- 第三步：问题收到答复后，会通过邮箱第一时间通知你；并且可以通过邮箱进行交流；
[示例](https://lists.apache.org/thread/x04mhql5vfyc0z41ksfykhppf2fg9o6r):https://lists.apache.org/thread/x04mhql5vfyc0z41ksfykhppf2fg9o6r
diff --git a/static/Images-zh/community/dragging-images.gif b/static/Images-zh/community/dragging-images.gif
new file mode 100644
index 0000000000..a5531992e8
Binary files /dev/null and b/static/Images-zh/community/dragging-images.gif differ
diff --git a/static/Images-zh/community/upload-file.png b/static/Images-zh/community/upload-file.png
new file mode 100644
index 0000000000..ba65a06363
Binary files /dev/null and b/static/Images-zh/community/upload-file.png differ
diff --git a/static/Images/community/dragging-images.gif b/static/Images/community/dragging-images.gif
new file mode 100644
index 0000000000..a5531992e8
Binary files /dev/null and b/static/Images/community/dragging-images.gif differ
diff --git a/static/Images/community/upload-file.png b/static/Images/community/upload-file.png
new file mode 100644
index 0000000000..ba65a06363
Binary files /dev/null and b/static/Images/community/upload-file.png differ
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@linkis.apache.org
For additional commands, e-mail: commits-help@linkis.apache.org