search

tkuester / taky

A simple python TAK server
MIT License
184 stars 43 forks source link

Docs not working for dumb user. #64

Open mighkel opened 2 years ago

mighkel commented 2 years ago

Figured I'd try to install taky from a dumb user standpoint. I failed... a few times. Decided to document it, but I'm not confident that it'll copy/paste here successfully, so I'll attach it. (created in Libre Office) taky_DU_feedback.odt

FarrantAlex commented 2 years ago

That's some great warts-and-all feedback! I'm not a maintainer but have a commercial interest in taky. I made a quick taky video last year aimed at beginners which uses an extra setup script in our fork. This script is obsolete now but should work for our fork. For the back story see: https://github.com/tkuester/taky/pull/18

If I have the time I can make a longer YT walk-through, but would prefer to spend the time improving the documentation which is an open issue (#41) but unfortunately a low priority. https://www.youtube.com/watch?v=SRpU5w6VgDY

tkuester commented 2 years ago

Of all the assistance that can be offered, documentation seems so insignificant -- but this feedback is invaluable. Thank you for taking the time to write it!

I've been away from taky for a bit, but I will definitely take some time to read it before releasing 0.9!

tkuester commented 2 years ago

AHHH I didn't credit you in the changelog! Boogers.

There's still more work to be done on the documentation. I think I need to pursue an "Apple" style documentation, where instead of presenting the users with a thousand different things, just show one way to do things.

But for now, there were at least two typos in there that you pointed out! More to come! (And I'll remember to credit you this time!)

SeawardDread commented 2 years ago

It would also be helpful to document a taky_dps restart please - while taky_dps starts the server, systemctl stop/restart taky_dps does not seem to affect the service. This may be down to an inconsistency, in which the service may in fact be taky-dps?