From 53ed332705825347b40fa48d366cd824fb477a80 Mon Sep 17 00:00:00 2001 From: Steve Gallo Date: Wed, 2 Aug 2017 11:43:14 -0400 Subject: [PATCH] Add Support section to README.md (#202) * Add support section to main readme * Add link to XDMoD support page * Request additional details for support requests --- README.md | 11 +++++++++++ docs/support.md | 10 +++++----- 2 files changed, 16 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 7fcb04c71d..8119fbf9a1 100644 --- a/README.md +++ b/README.md @@ -21,6 +21,17 @@ For more information, including information about additional Open XDMoD capabilities provided as optional modules, please visit [the Open XDMoD website](http://open.xdmod.org). +## Support + +Support is available by emailing ccr-xdmod-help@buffalo.edu. Please include the following in your support request. Failure to include this information may delay support. See the [Open XDMoD Support](http://open.xdmod.org/support.html) page for additional information. + +- Open XDMoD version number +- Operating system and version where Open XDMoD is installed +- The output of `xdmod-check-config` +- PHP and MySQL version (e.g, the output from `php --version`, `mysql --version`, and the SQL command `SHOW VARIABLES LIKE "%version%";`) +- A description of the problem you are experiencing +- Detailed steps to reproduce the problem + ## Modules for Open XDMoD In addition to the analysis functionality provided by the main Open XDMoD diff --git a/docs/support.md b/docs/support.md index 5e525392ff..703726be9e 100644 --- a/docs/support.md +++ b/docs/support.md @@ -2,14 +2,14 @@ title: Support --- -Email `ccr-xdmod-help` at `buffalo.edu` for support. - -Please include the following in your email: +Email `ccr-xdmod-help` at `buffalo.edu` for support. Please include the following in your support request. Failure to include this information may delay support. - Open XDMoD version number - Operating system and version where Open XDMoD is installed -- Description of the problem you are experiencing -- Steps to reproduce the problem +- The output of `xdmod-check-config` +- PHP and MySQL version (e.g, the output from `php --version`, `mysql --version`, and the SQL command `SHOW VARIABLES LIKE "%version%";`) +- A description of the problem you are experiencing +- Detailed steps to reproduce the problem Mailing List ------------