MantisBT - Doomseeker
View Issue Details
IDProjectCategoryView StatusDate SubmittedLast Update
0003526Doomseeker[All Projects] Documentationpublic2018-09-29 01:482024-11-03 19:10
ReporterWubTheCaptain 
Assigned ToZalewa 
PrioritylowSeveritytextReproducibilityalways
StatusclosedResolutionfixed 
PlatformOSOS Version
Product Version1.0 
Target Version1.4.0Fixed in Version1.4.0 
Summary0003526: README doesn't provide information how to find support for use (or inform there's no official support available)
DescriptionWe only have "Contact information" available in "About" in the Doomseeker binary (as ambiguous at its purpose is), but no information for troubleshooting and finding help in the source (especially in the README.md file).

If we don't want to provide support, then it'd be best to say at least "no official support is available" to have users fix their own issues, and/or point to other resources for support.
Steps To Reproduce1.1-p1:'https://bitbucket.org/Doomseeker/doomseeker/src/d22e1ef5e8beab41193f878105163327f54dabe8/README.md?at=default&fileviewer=file-view-default [^]'
1.2~beta-1 (Mercurial tip at time of creating this ticket):'https://bitbucket.org/Doomseeker/doomseeker/src/1a55359fed00d2c35d6fd2aba1c436663175cbe8/README.md?at=default&fileviewer=file-view-default [^]'
Additional InformationThere's typically three kinds of user support requests:

  • Bug reports: Something isn't working for me.
  • Suggestions: I would like to do X, but it doesn't exist yet.
  • Questions: How do I...?


There's also two big dividers in the type of support requests:

  • Users, who need help with their own situation
  • Developers, who need help contributing back to the project
TagsNo tags attached.
Relationships
parent of 0003535closed WubTheCaptain Contact information (from "About" dialog) is missing from README 
child of 0003594confirmed  Documentation sprint #1: Undocumented support & contributing READMEs 
Attached Files
Issue History
Date ModifiedUsernameFieldChange
2018-09-29 01:48WubTheCaptainNew Issue
2018-10-05 06:42WubTheCaptainNote Added: 0019912
2018-10-05 06:42WubTheCaptainAssigned To => WubTheCaptain
2018-10-05 06:42WubTheCaptainStatusnew => feedback
2018-10-05 06:42WubTheCaptainTarget Version => 1.2
2018-10-05 19:51ZalewaNote Added: 0019919
2018-10-05 19:52ZalewaNote Edited: 0019919bug_revision_view_page.php?bugnote_id=19919#r12103
2018-10-06 08:56WubTheCaptainNote Added: 0019921
2018-10-06 08:56WubTheCaptainStatusfeedback => assigned
2018-10-06 08:56WubTheCaptainStatusassigned => acknowledged
2018-10-06 09:41WubTheCaptainNote Added: 0019923
2018-10-06 09:41WubTheCaptainTarget Version1.2 => 1.3
2018-10-06 09:53WubTheCaptainNote Added: 0019926
2018-10-06 10:06WubTheCaptainRelationship addedparent of 0003535
2018-10-06 10:08WubTheCaptainNote Added: 0019928
2018-10-06 10:20WubTheCaptainProduct Version1.1 => 1.0
2018-12-17 05:24WubTheCaptainCategoryBug => Documentation
2019-01-06 06:25WubTheCaptainRelationship addedrelated to 0003591
2019-01-06 06:59WubTheCaptainRelationship deletedrelated to 0003591
2019-01-06 07:05WubTheCaptainRelationship addedchild of 0003594
2019-01-06 07:28WubTheCaptainStatusacknowledged => confirmed
2019-06-23 02:55WubTheCaptainPrioritynormal => low
2019-06-23 02:55WubTheCaptainTarget Version1.3 =>
2022-08-25 10:22WubTheCaptainAssigned ToWubTheCaptain =>
2022-09-10 07:49ZalewaNote Added: 0022378
2022-09-10 07:49ZalewaAssigned To => Zalewa
2022-09-10 07:49ZalewaStatusconfirmed => assigned
2022-09-10 14:30ZalewaTarget Version => 1.4.0
2022-09-10 15:15ZalewaNote Edited: 0022378bug_revision_view_page.php?bugnote_id=22378#r13717
2022-09-11 21:16ZalewaStatusassigned => feedback
2022-09-11 21:16ZalewaNote Edited: 0022378bug_revision_view_page.php?bugnote_id=22378#r13727
2022-09-12 03:58WubTheCaptainNote Added: 0022395
2022-09-12 03:58WubTheCaptainStatusfeedback => assigned
2022-09-17 09:35ZalewaNote Added: 0022400
2022-09-17 09:35ZalewaStatusassigned => resolved
2022-09-17 09:35ZalewaFixed in Version => 1.4.0
2022-09-17 09:35ZalewaResolutionopen => fixed
2024-11-03 19:10ZalewaStatusresolved => closed

Notes
(0019912)
WubTheCaptain   
2018-10-05 06:42   
Which forms of support should be listed?

  • Email? (Individuals? No mailing list available, yet.)
  • IRC, Matrix.org? (There's no channel/room at the moment, afaik.)
  • Issue tracker on Zandronum.com?
  • Something else?
(0019919)
Zalewa   
2018-10-05 19:51   
(edited on: 2018-10-05 19:52)
We have the home page at'https://doomseeker.drdteam.org/ [^]' so maybe we could point there and add some directions to contact us through "Tracker" or add a "Contact Us/Support" sub page to the home page?

There's also help for Doomseeker on Zandronum's wiki:'https://wiki.zandronum.com/Install_Doomseeker [^]'
(0019921)
WubTheCaptain   
2018-10-06 08:56   
Quote from Zalewa
We have the home page at'https://doomseeker.drdteam.org/ [^]' so maybe we could point there


I would add a "home page" to the README. More general directions to where to get support (not via browsing the home page) is still desirable.

Think: Someone with no Internet access, wanting to immediately find where to find support at the next chance they get connectivity again. An alternative example: An email address to contact, so that the user may immediately start writing an email to that address, which will be delivered the next time the user has connectivity to the Internet.

Pointers to man pages and such would probably be good, too.

Quote from Zalewa
add a "Contact Us/Support" sub page to the home page?


This suggestion is somewhat "out of scope" for this ticket. The information within should also be available from README.
(0019923)
WubTheCaptain   
2018-10-06 09:41   
I feel like this should be a 1.2 feature/tweak, but I'm lazy so... → 1.3.
(0019926)
WubTheCaptain   
2018-10-06 09:53   
Quote from WubTheCaptain
I would add a "home page" to the README.


Looks like we already have this.
(0019928)
WubTheCaptain   
2018-10-06 10:08   
Quote from WubTheCaptain
I feel like this should be a 1.2 feature/tweak, but I'm lazy so... → 1.3.


0003535 is fine to merge into 1.2 as a first step, though.
(0022378)
Zalewa   
2022-09-10 07:49   
(edited on: 2022-09-11 21:16)
This ticket is way outdated given how simple it should be to fix. I'm thinking about adding this to the readme and calling it a day:

--- a/README.md
+++ b/README.md
@@ -9,6 +9,9 @@ library.
 Doomseeker and Wadseeker are licensed under the GNU LGPL v2.1 or later.
 
 * [Website](https://doomseeker.drdteam.org)
+* [Install Guide](https://wiki.zandronum.com/Install_Doomseeker)
+* Suggestions & bug reporting: [Zandronum Tracker](https://zandronum.com/tracker/)
+ / Doomseeker project
+* Direct support: [Zandronum Discord](https://discord.gg/8QqxCBR)
 
 Compiling
 ---------


One small thing is that I can't find a way to tell Mantis to select the Doomseeker project by URL. Someone who's opening the tracker for the first time by this URL will see the "All Projects" view.
(0022395)
WubTheCaptain   
2022-09-12 03:58   
Quote
Status: feedback

As the reporter, 0003526:0022378 diff looks good to me.
(0022400)
Zalewa   
2022-09-17 09:35   
'https://bitbucket.org/Doomseeker/doomseeker/commits/f3f8b686b511eecde318220fd1c655ff6bc9224a [^]'