From bfc96375cee1a65c7547e4f02642d1b000d6c61a Mon Sep 17 00:00:00 2001 From: Daniel Gibbs Date: Sun, 6 Jan 2019 22:38:14 +0000 Subject: [PATCH] fix(docs): update style based on codacy feedback --- .github/ISSUE_TEMPLATE/bug_report.md | 17 ++++++++-------- .github/ISSUE_TEMPLATE/feature_request.md | 21 ++++++++++++-------- .github/ISSUE_TEMPLATE/new-server-request.md | 11 ++++++---- README.md | 6 ++++++ 4 files changed, 35 insertions(+), 20 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 87f5ddc5e..91d97d746 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -21,21 +21,21 @@ Any general support issues on GitHub will be closed. *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] -* Game [Garry's Mod] -* Feature [Monitor] +* Distro \[Ubuntu 18.04] +* Game \[Garry's Mod] +* 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. -# To Reproduce +## To Reproduce Steps to reproduce the behaviour: 1. Go to '...' @@ -44,4 +44,5 @@ Steps to reproduce the behaviour: 4. See error ## Expected behaviour + A what you expected to happen. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 9c73c44a4..257ee1df5 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -12,6 +12,7 @@ Issues here are **ONLY** for: * code contributions Issues here are **NOT** for: + * General support * Specific game server issues (e.g CS:GO, TF2) * 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* -# User Story -As a [user description], I want \[desired action] so that \[desired outcome] +## User Story + +As a \[user description], I want \[desired action] so that \[desired outcome] + +## Basic info -# Basic info -- Distro [Ubuntu 18.04] -- Game [Garry's Mod] -- Feature [Monitor] +* Distro \[Ubuntu 18.04] +* Game \[Garry's Mod] +* Feature \[Monitor] + +## Further Information -# Further Information 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. diff --git a/.github/ISSUE_TEMPLATE/new-server-request.md b/.github/ISSUE_TEMPLATE/new-server-request.md index 4300ef3da..c6a2c82d0 100644 --- a/.github/ISSUE_TEMPLATE/new-server-request.md +++ b/.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. -# 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? +## Is the server supported on Linux? + We only support Linux servers and do not support Wine. diff --git a/README.md b/README.md index e4a8cc474..0daf95455 100644 --- a/README.md +++ b/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. ## 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. ## Main features + 80+ game servers supported - :truck: Installer - :mag: Monitor @@ -21,6 +23,7 @@ Traditionally game servers are not easy to manage yourself. Admins often have to - :computer: Console ## :penguin: Compatibility + Linux Game Server Managers are tested to work on the following Linux distros. - 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. ## :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. - [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) ## :question: Support + There are a various ways to get support, check out the [support](https://linuxgsm.com/support/) page to the right support. ## :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.