소스 검색

Added getting help section

Björn Ritzl 6 년 전
부모
커밋
105936a604
3개의 변경된 파일60개의 추가작업 그리고 0개의 파일을 삭제
  1. 4 0
      docs/en/en.json
  2. 56 0
      docs/en/manuals/getting-help.md
  3. BIN
      docs/en/manuals/images/getting_help/report_issue.png

+ 4 - 0
docs/en/en.json

@@ -168,6 +168,10 @@
                     {
                         "path": "/manuals/flash",
                         "name": "Defold for Flash users"
+                    },
+                    {
+                        "path": "/manuals/getting_help",
+                        "name": "Getting help"
                     }
                 ]
             },

+ 56 - 0
docs/en/manuals/getting-help.md

@@ -0,0 +1,56 @@
+---
+title: How to get help
+brief: This manual describes how to get help if you run into a problem while using Defold.
+---
+
+# Getting help
+
+If you run into a problem while using Defold we'd like to hear from you so that we can fix the issue and/or help you work around the problem! There are several ways to discuss and also report issues. Chose the option that works best for you:
+
+## Report a problem on the forum
+
+A good way to discuss and get help with a problem is to post a question on our [forum](https://www.defold.com). Post either in the [Questions](https://forum.defold.com/c/questions) or [Bugs](https://forum.defold.com/c/bugs) category depending on the type of problem you have. When you post a support question make sure to include as much information as possible. Remember to [search](https://forum.defold.com/search) for your question/issue before asking as there may already be a solution to your problem.You must include the following for us to provide help:
+
+* **Describe the bug (REQUIRED)** - A clear and concise description of the problem.
+
+* **To Reproduce (REQUIRED)** - Steps to reproduce the problem:
+ 1. Go to '...'
+ 2. Click on '....'
+ 3. Scroll down to '....'
+ 4. See error
+
+* **Expected behavior (REQUIRED)** - A clear and concise description of what you expected to happen.
+
+* **Defold version (REQUIRED)** - Version [e.g. 1.2.155]. Preferably also the SHA1 of the engine and editor, as seen in the <kbd>Help->About</kbd> menu option.
+
+* **Platforms (REQUIRED)** - On which platforms does the problem happen?
+ - Platforms: [e.g. iOS, Android, Windows, macOS, Linux, HTML5]
+ - OS: [e.g. iOS8.1, Windows 10, High Sierra]
+ - Device: [e.g. iPhone6]
+
+* **Logs (OPTIONAL)** - Please include any relevant logs. This can be device logs or editor logs. Editor logs are located here:
+ - Windows: C:\Users\ **Your Username** \AppData\Local\Defold
+ - macOS: /Users/ **Your Username** /Library/Application Support/ or ~/Library/Application Support/Defold
+ - Linux: ~/.Defold
+
+* **Minimal repro case project (OPTIONAL)** - Please attach a minimal project where the bug is reproduced. This will greatly help the person trying to investigate and fix the bug.
+
+* **Workaround (OPTIONAL)** - If there is a workaround, please describe it here.
+
+* **Screenshots (OPTIONAL)** - If applicable, add screenshots to help explain your problem.
+
+* **Additional context (OPTIONAL)** - Add any other context about the problem here.
+
+
+## Report a problem from the editor
+
+The editor provides a convenient way to report issues. Select the <kbd>Help->Report Issue</kbd> menu option from within the editor to report an issue.
+
+![](images/getting_help/report_issue.png)
+
+Selecting this menu option will bring you to an issue tracker on GitHub. Please fill out the form and include as much information as possible. Note that you need a GitHub account to submit a bug report this way.
+
+
+## Discuss a problem on Slack
+
+If you run into a problem while using Defold you can try to ask the question on [Slack](https://www.defold.com/slack/). We do however recommend that complex questions and in-depth discussions are posted on the forum. Also note that we do not accept bug reports submitted through Slack.

BIN
docs/en/manuals/images/getting_help/report_issue.png