Mention docker image in READMNE

[ppbrown]

Please update readme to directly point to whereever is the new location for https://hub.docker.com/r/scottlamb/moonfire-nvr ?

for that matter, it would be nice if you updated the thing THERE, to directly point to the new docker repo, instead of just vaguely mentioning "ghcr.io" ?

PS: would also be nice to have more setup details on the docker image. For example, what volume arguments to use, to make it so it stores video output under a specific location.

[scottlamb]

What are you hoping to learn from that link that isn't present in the linked install instructions?

[ppbrown]

Just a faster absorption. Most github projects that have an OFFICIAL docker image, point to it from the top level README. And then they have docker-specific install instructions, at the top level of the dockerhub page.

Nice example of the latter:

https://hub.docker.com/r/zoneminderhq/zoneminder

[scottlamb]

ghcr.io doesn't let you customize its package pages at all AFAICT; it just shows the github project's README, so linking to it from the github project's README would be circular and unhelpful. The package is here but there's really nothing to see.

I'd rather not follow that zoneminder page's example. It tells me how to start a Docker image but that's not really enough to set up and use the software. It says "Note: Detailled usage instructions for the development and release Dockerfiles are contained within each Dockerfile.", but looking through the dockerfiles is really not the right thing to expect non-devs to do, and when I looked at one of the several Dockerfiles, it didn't describe how to set up and use the software either. I would have expected a link to the software's official installation guide, except that page has a banner at the top saying "This entire guide needs to be checked/updated as needed", so I assume they just don't have any decent documentation.

https://hub.docker.com/r/scottlamb/moonfire-nvr is deprecated (how did you end up there?) but still links to a current installation guide that I expect to actually work. Docker isn't my recommended way to install, but Docker installation is described on that page.

[ppbrown]

I have to run it in docker. theres too many conflicts with other things running on the machine.

Perhaps you might split your main install instructions, into separate pages for normal, vs docker-specific things. Then pointing the dockerhub page, at the docker specific install instructions, would be very helpful.

You say in the main readme, that you want to "make it great!"

51% of making that happen, is making the documentation easy to read, and easy to use. Currently, from a new user perspective, it is neither.

You're writing it like a coder who just wants to get back to coding :-) rather than a docs writer who wants new users to have as painless an experience as possible.

Speaking as a software writer myself, trying to switch hats from coder to tech writer, has other benefits. if you can change gears to look at things from a new user perspective, sometimes writing the new-user docs, makes you realize, "Huh... This setup procedure could use some cleanup, too"

[scottlamb]

I have to run it in docker. theres too many conflicts with other things running on the machine.

This is almost certainly not true. It's a single statically-linked binary. It is very hard to screw up the host so badly that Moonfire won't run; if you do, Docker won't run either.

You're writing it like a coder who just wants to get back to coding :-) rather than a docs writer who wants new users to have as painless an experience as possible.

I've put a lot of effort into good user-facing docs. Questions, bug reports, and PRs that improve the docs or software are welcome. Drive-by complaints / incorrect assumptions about my mindset / preaching are not.

[ppbrown]

Telling a new user, who is giving you feedback "your docs for new users are lacking",

"hey, make them better yourself".

is the epitome of Bad user interaction. A person has to UNDERSTAND THE PRODUCT, before they can write better docs. I've already said I'm a new user, and dont understand the product.

Poor attitude, man. I'll look elsewhere for my nvr needs.

[scottlamb]

I'll look elsewhere for my nvr needs.

Sounds good.

There are a lot of ways I'd like to make Moonfire NVR easier to install and use, like having all the configuration possible through the web UI rather than having to start up a separate TUI-based config interface, shut that down, and then go to the web interface. But I have very little cycles to spend on the project, and arguing with you on github issues isn't helping.