Add a feedback doc and modify the main page to TRY to get people to figure out how to properly report bugs.
ackis [02-17-09 - 03:58]
Add a feedback doc and modify the main page to TRY to get people to figure out how to properly report bugs.
diff --git a/.docmeta b/.docmeta
index ce59c84..dcfb9e4 100644
--- a/.docmeta
+++ b/.docmeta
@@ -4,6 +4,10 @@
output-page: "Database Documentation"
-
type: wiki
+ input-file: Docs/Feedback.txt
+ output-page: "Feedback"
+-
+ type: wiki
input-file: Docs/Main.txt
output-page: "Main"
-
diff --git a/Docs/Feedback.txt b/Docs/Feedback.txt
new file mode 100644
index 0000000..2b246f5
--- /dev/null
+++ b/Docs/Feedback.txt
@@ -0,0 +1,27 @@
+==How to report a bug==
+
+Please read below very carefully ''before'' attempting to report a bug. Read ''everything'' on this page if you use an alpha or beta version.
+
+# '''DO NOT report bugs in the comments section!'''
+# Please use the ticket system to report bugs
+# ALWAYS '''check [http://www.wowace.com/projects/arl/tickets/?filter_status=+&filter_type=d older tickets]''' first
+# Disable all other addons and retry
+# Remember to confirm your version number
+# Finally, read [http://www.wowace.com/knowledge-base/how-to-file-tickets/ this]
+
+If you've understood all that, then '''[http://www.wowace.com/projects/arl/create-ticket/ proceed here to report a bug]''' and I thank you for your time. Check back later in case I need further feedback or confirmation that a bug has been fixed for you.
+
+You can also use the ticket system to request a new feature or for any other issue (e.g. providing/requesting a translation).
+
+==Addon conflicts==
+
+Please don't report conflicts with other addons to their authors unless you're using a stable release (non-alpha, non-beta) version of Ackis Recipe List. However, do tell me in either case.
+
+Don't include your list of addons when pasting error logs. If there's an addon conflict, there's no practical way I can test each of them, so you must identify the conflict. A good way to do that is with something like [http://wow.curse.com/downloads/wow-addons/details/acp.aspx ACP], which can disable and enable addons in-game.
+
+==If you use a Beta or Alpha release==
+
+* Has the bug already been fixed? '''Read the changelog''' of the latest alpha release [http://www.wowace.com/projects/arl/files/ here]
+* If you choose to use an alpha revision, make sure you're using the latest revision and pay attention to the changelog
+
+Remember that alpha versions are development-only releases, primarily for the author's benefit. Beta versions are specifically put out their for testing purposes for willing users and, as such, are not guaranteed to be stable for normal use.
diff --git a/Docs/Main.txt b/Docs/Main.txt
index 642a7c1..b4bb115 100644
--- a/Docs/Main.txt
+++ b/Docs/Main.txt
@@ -36,26 +36,28 @@ Ackis Recipe List has recently changed to use a GUI for change parameters. Type
* If you have a cooking or first aid book/quest complete, but aren't past the skill level, it'll show the book/quest as unknown (ie: I have read the first aid skill book for skill level 150, however my skill in first aid is only 140, it'll show the book as unknown still).
* Recipe acquire information is slightly inaccurate. I'm updating recipes daily as information is identified. If you find something inaccurate or wrong, submit a ticket [http://www.wowace.com/projects/arl/create-ticket/ here] and I will get it updated.
-==Bug Reports==
+==Feature Requests/Bug Reporting==
+Read the [http://www.wowace.com/projects/arl/pages/feedback/ Bug Reporting and Feature Requesting] information ''before'' submitted a bug report or feature request. Posting reports in the comments is ''not'' the place to do so. I had to turn off the comments at [http://wow.curse.com/downloads/wow-addons/details/arl.aspx Curse.com] because of of constant bug reports and feature requests. Comments are for questions on how to use the mod, or you can see the thread on [http://forums.wowace.com/showthread.php?t=11142 WoW Ace]. Please follow these small little instructions to make my life easier. The easier you make development for Ackis Recipe List, the more time I will have to develop other addons.
+
+===Bug Reports===
Please use the [http://www.wowace.com/projects/arl/tickets/ WoW Ace] tracker to file bug reports. Posting bugs in the comments is not the place to do it.
-==Wish List==
-Please use the [http://www.wowace.com/projects/arl/tickets/ WoW Ace] tracker to add suggestions and feature requests.
+===Feature Request===
+Please use the [http://www.wowace.com/projects/arl/tickets/ WoW Ace] tracker to add suggestions and feature requests. Not all suggestions will be accepted, there are a lot of people using this addon and I'll try to make it as user friendly, but when a decision is made please accept it.
==Integration==
-Ackis Recipe List strives to integrate with existing trade skill mods out there. If you have a request for integration, please submit a feature request at [http://www.wowace.com/projects/arl/tickets/ WoW Ace]. There is a limited API documented at [http://www.wowace.com/projects/arl/pages/API/] to interface with the ARL database. If you are a developer and would like more functions, please contact me on IRC.
+Ackis Recipe List strives to integrate with existing trade skill mods out there. If you have a request for integration, please submit a feature request at [http://www.wowace.com/projects/arl/tickets/ WoW Ace]. There is a limited API documented at [http://www.wowace.com/projects/arl/pages/api/] to interface with the ARL database. If you are a developer and would like more functions, please contact me on IRC.
Currently, the mod works with:
* Advanced Trade Skill Window
* Skillet
* Manufac
-
-==Bug Reporting==
-Please use the [http://www.wowace.com/projects/arl/tickets/ WoW Ace] tracker to file bug reports.
+* Cauldron
==Detailed Documentation==
-* Detailed documentation - [http://www.wowace.com/projects/arl/pages/database-documentation/]
-* API - [http://www.wowace.com/projects/arl/pages/API/]
-* Localization - [http://www.wowace.com/projects/arl/pages/Localization/]
+* API - [http://www.wowace.com/projects/arl/pages/api/]
+* Database Documentation - [http://www.wowace.com/projects/arl/pages/database-documentation/]
+* Bug Reporting and Feature Requestiing - [http://www.wowace.com/projects/arl/pages/feedback/]
+* Localization - [http://www.wowace.com/projects/arl/pages/localization/]
==Acknowledgments==
* Ideas for the mod came from FGTradeLacker (original mod no longer updated, however someone has taken over updating the recipes for it).