ソースを参照

feat(docs): improve various documentation

Daniel Gibbs 7 年 前
コミット
2edc3fa481

+ 16 - 23
.github/ISSUE_TEMPLATE/bug_report.md

@@ -4,48 +4,41 @@ name: Bug report
 about: Found a bug? Raise a report
 
 ---
-
 Follow **[this guide](https://linuxgsm.com/support/#guide)** to make sure you post the correct info.
-For general support visit the **[steam group](https://linuxgsm.com/steam)**.
+For general support visit the **[LinuxGSM-Support](https://github.com/GameServerManagers/LinuxGSM-Support)**.
 
-GitHub is **ONLY** for:
-```
+Issues here are **ONLY** for:
 * LinuxGSM bugs
 * feature suggestions
 * code contributions
-```
 
-GitHub is **NOT** for:
-```
+Issues here are **NOT** for:
 * General support
 * Specific game server issues (e.g CS:GO, TF2)
 * Dedicated server issues (e.g Ubuntu, CentOS)
 * Anything not directly related to LinuxGSM development
-```
+
 Any general support issues on GitHub will be closed.
 
 *Please use the template below*
 
-**Basic info**
-Game: 
-Distro: 
+## User Story
+As a [user description], I want [desired action] so that [desired outcome]
+
+## Basic info 
+- Distro [Ubuntu 18.04]
+- Game [Garry's Mod]
+- Feature [Monitor]
 
-**Describe the bug**
-A clear and concise description of what the bug is.
+## Further Information
+A clear description of what the bug is and any ideas on how to resolve it. Plus any further context that might be relevant to the issue.
 
-**To Reproduce**
+## To Reproduce
 Steps to reproduce the behaviour:
 1. Go to '...'
 2. Click on '....'
 3. Scroll down to '....'
 4. See error
 
-**Expected behaviour**
-A clear and concise description of what you expected to happen.
-
-**Minimum Information**
-The game server you are running (e.g. Rust/CS:GO).
-The link from `./gameserver postdetails` command.
-
-**Additional context**
-Add any other context about the problem here.
+## Expected behaviour
+A what you expected to happen.

+ 13 - 16
.github/ISSUE_TEMPLATE/feature_request.md

@@ -3,16 +3,15 @@ name: Feature request
 about: Suggest an idea for this project
 
 ---
-
 Follow **[this guide](https://linuxgsm.com/support/#guide)** to make sure you post the correct info.
-For general support visit the **[steam group](https://linuxgsm.com/steam)**.
+For general support visit the **[LinuxGSM-Support](https://github.com/GameServerManagers/LinuxGSM-Support)**.
 
-GitHub is **ONLY** for:
+Issues here are **ONLY** for:
 * LinuxGSM bugs
 * feature suggestions
 * code contributions
 
-GitHub is **NOT** for:
+Issues here are **NOT** for:
 * General support
 * Specific game server issues (e.g CS:GO, TF2)
 * Dedicated server issues (e.g Ubuntu, CentOS)
@@ -22,18 +21,16 @@ Any general support issues on GitHub will be closed.
 
 *Please use the template below*
 
-**Basic info**
-Game: 
-Distro: 
-
-**Is your feature request related to a problem? Please describe.**
-A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+## User Story
+As a [user description], I want [desired action] so that [desired outcome]
 
-**Describe the solution you'd like**
-A clear and concise description of what you want to happen.
+## Basic info 
+- Distro [Ubuntu 18.04]
+- Game [Garry's Mod]
+- Feature [Monitor]
 
-**Describe alternatives you've considered**
-A clear and concise description of any alternative solutions or features you've considered.
+## Further Information
+A clear description of what the feature is and any ideas on how to achieve this.
 
-**Additional context**
-Add any other context or screenshots about the feature request here.
+## Further Reading
+Provide any useful documentation or resources that might help.

+ 6 - 6
.github/ISSUE_TEMPLATE/new-server-request.md

@@ -4,13 +4,13 @@ about: Suggest a new game server to be added
 
 ---
 
-**What game server would you like adding?**
+## What game server would you like adding?
 
-**Can you link to any tutorials or guides?**
-Any useful guides will help with development
+## Can you link to any tutorials or guides?
+Provide any useful documentation or resources that might help.
 
-**Is the server on Steam?**
+## Is the server on Steam?
 If yes Use SteamDB to get the appid. (https://steamdb.info)
 
-**Is the server supported on Linux?**
-We only support Linux servers and do not support Wine.
+## Is the server supported on Linux?
+We only support Linux servers and do not support Wine.

+ 4 - 6
ISSUE_TEMPLATE.md

@@ -1,17 +1,15 @@
-Please select the "Preview" tab above to view this message correctly.
-
 Follow **[this guide](https://linuxgsm.com/support/#guide)** to make sure you post the correct info.
-For general support visit the **[steam group](https://linuxgsm.com/steam)**
+For general support visit the **[LinuxGSM-Support](https://github.com/GameServerManagers/LinuxGSM-Support)**.
 
-GitHub is **ONLY** for:
+Issues here are **ONLY** for:
 * LinuxGSM bugs
 * feature suggestions
 * code contributions
 
-GitHub is **NOT** for:
+Issues here are **NOT** for:
 * General support
 * Specific game server issues (e.g CS:GO, TF2)
 * Dedicated server issues (e.g Ubuntu, CentOS)
 * Anything not directly related to LinuxGSM development
 
-**Any general support issues on GitHub will be closed.**
+Any general support issues on GitHub will be closed.

ファイルの差分が大きいため隠しています
+ 5 - 1
README.md


この差分においてかなりの量のファイルが変更されているため、一部のファイルを表示していません