Browse Source

fix(docs): update style based on codacy feedback

pull/2151/head
Daniel Gibbs 6 years ago
parent
commit
bfc96375ce
  1. 17
      .github/ISSUE_TEMPLATE/bug_report.md
  2. 21
      .github/ISSUE_TEMPLATE/feature_request.md
  3. 11
      .github/ISSUE_TEMPLATE/new-server-request.md
  4. 6
      README.md

17
.github/ISSUE_TEMPLATE/bug_report.md

@ -21,21 +21,21 @@ Any general support issues on GitHub will be closed.
*Please use the template below* *Please use the template below*
# User Story ## User Story
As a [user description], I want \[desired action] so that \[desired outcome] As a \[user description], I want \[desired action] so that \[desired outcome]
# Basic info ## Basic info
* Distro [Ubuntu 18.04] * Distro \[Ubuntu 18.04]
* Game [Garry's Mod] * Game \[Garry's Mod]
* Feature [Monitor] * Feature \[Monitor]
# Further Information ## 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. 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: Steps to reproduce the behaviour:
1. Go to '...' 1. Go to '...'
@ -44,4 +44,5 @@ Steps to reproduce the behaviour:
4. See error 4. See error
## Expected behaviour ## Expected behaviour
A what you expected to happen. A what you expected to happen.

21
.github/ISSUE_TEMPLATE/feature_request.md

@ -12,6 +12,7 @@ Issues here are **ONLY** for:
* code contributions * code contributions
Issues here are **NOT** for: Issues here are **NOT** for:
* General support * General support
* Specific game server issues (e.g CS:GO, TF2) * Specific game server issues (e.g CS:GO, TF2)
* Dedicated server issues (e.g Ubuntu, CentOS) * Dedicated server issues (e.g Ubuntu, CentOS)
@ -21,16 +22,20 @@ Any general support issues on GitHub will be closed.
*Please use the template below* *Please use the template below*
# User Story ## User Story
As a [user description], I want \[desired action] so that \[desired outcome]
As a \[user description], I want \[desired action] so that \[desired outcome]
## Basic info
# Basic info * Distro \[Ubuntu 18.04]
- Distro [Ubuntu 18.04] * Game \[Garry's Mod]
- Game [Garry's Mod] * Feature \[Monitor]
- Feature [Monitor]
## Further Information
# Further Information
A clear description of what the feature is and any ideas on how to achieve this. A clear description of what the feature is and any ideas on how to achieve this.
# Further Reading ## Further Reading
Provide any useful documentation or resources that might help. Provide any useful documentation or resources that might help.

11
.github/ISSUE_TEMPLATE/new-server-request.md

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

6
README.md

@ -8,9 +8,11 @@
[LinuxGSM](https://linuxgsm.com) is the command line tool for quick, simple deployment and management of dedicated game servers. [LinuxGSM](https://linuxgsm.com) is the command line tool for quick, simple deployment and management of dedicated game servers.
## Hassle-Free Dedicated Game Servers ## Hassle-Free Dedicated Game Servers
Traditionally game servers are not easy to manage yourself. Admins often have to spend hours just messing around trying to get their server working. LinuxGSM is designed to be as simple as possible allowing admins to spend less time on management and more time gaming. Traditionally game servers are not easy to manage yourself. Admins often have to spend hours just messing around trying to get their server working. LinuxGSM is designed to be as simple as possible allowing admins to spend less time on management and more time gaming.
## Main features ## Main features
80+ game servers supported 80+ game servers supported
- :truck: Installer - :truck: Installer
- :mag: Monitor - :mag: Monitor
@ -21,6 +23,7 @@ Traditionally game servers are not easy to manage yourself. Admins often have to
- :computer: Console - :computer: Console
## :penguin: Compatibility ## :penguin: Compatibility
Linux Game Server Managers are tested to work on the following Linux distros. Linux Game Server Managers are tested to work on the following Linux distros.
- Debian based (Ubuntu, Mint etc.) - Debian based (Ubuntu, Mint etc.)
@ -29,6 +32,7 @@ Linux Game Server Managers are tested to work on the following Linux distros.
Other distros are likely to work but are not fully tested. Other distros are likely to work but are not fully tested.
## :wrench: Requirements ## :wrench: Requirements
Each game server has its own specific dependency requirements, but most require GLIBC and Tmux. Visit the specific game server installation page on the [LinuxGSM](https://linuxgsm.com) website to see dependencies. Each game server has its own specific dependency requirements, but most require GLIBC and Tmux. Visit the specific game server installation page on the [LinuxGSM](https://linuxgsm.com) website to see dependencies.
- [GLIBC](https://docs.linuxgsm.com/requirements/glibc) >= 2.15 recommended [[specific requirements]](https://docs.linuxgsm.com/requirements/glibc#server-requirements) - [GLIBC](https://docs.linuxgsm.com/requirements/glibc) >= 2.15 recommended [[specific requirements]](https://docs.linuxgsm.com/requirements/glibc#server-requirements)
@ -37,7 +41,9 @@ Each game server has its own specific dependency requirements, but most require
Documentation is found at [linuxgsm.com](https://linuxgsm.com) and [docs.linuxgsm.com](https://docs.linuxgsm.com) Documentation is found at [linuxgsm.com](https://linuxgsm.com) and [docs.linuxgsm.com](https://docs.linuxgsm.com)
## :question: Support ## :question: Support
There are a various ways to get support, check out the [support](https://linuxgsm.com/support/) page to the right support. There are a various ways to get support, check out the [support](https://linuxgsm.com/support/) page to the right support.
## :heart: Donate ## :heart: Donate
If you would like to [donate](https://linuxgsm.com/donate) to the project there are several ways you can, via [PayPal](https://www.paypal.me/dgibbs64), [Patreon](https://www.patreon.com/dgibbs) and [Flattr](https://flattr.com/@dgibbs). I would like to thank everyone who has previously sent a donation. LinuxGSM has been going since 2012 and I have spent 1000s of hours developing and improving the project and continue to regularly add support for new servers. If you would like to [donate](https://linuxgsm.com/donate) to the project there are several ways you can, via [PayPal](https://www.paypal.me/dgibbs64), [Patreon](https://www.patreon.com/dgibbs) and [Flattr](https://flattr.com/@dgibbs). I would like to thank everyone who has previously sent a donation. LinuxGSM has been going since 2012 and I have spent 1000s of hours developing and improving the project and continue to regularly add support for new servers.

Loading…
Cancel
Save