Browse Source

feat(docs): improve various documentation

pull/2151/head
Daniel Gibbs 6 years ago
committed by GitHub
parent
commit
2edc3fa481
No known key found for this signature in database GPG Key ID: 4AEE18F83AFDEB23
  1. 39
      .github/ISSUE_TEMPLATE/bug_report.md
  2. 29
      .github/ISSUE_TEMPLATE/feature_request.md
  3. 12
      .github/ISSUE_TEMPLATE/new-server-request.md
  4. 10
      ISSUE_TEMPLATE.md
  5. 97
      README.md

39
.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.

29
.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.

12
.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.

10
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.

97
README.md

File diff suppressed because one or more lines are too long
Loading…
Cancel
Save