Missing Documentation: factoriolab

[novahahn]

Describe the problem

I haven't been able to find documentation on how to run the package factoriolab. It does not provide a binary and the instructions upstream (https://github.com/factoriolab/factoriolab#running-locally) are not applicable either.

Proposed solution

Notify maintainers

@PatrickDaG

---

Note for maintainers: Please tag this issue in your pull request description. (i.e. Resolves #ISSUE.)

I assert that this issue is relevant for Nixpkgs

• I assert that this request is not already implemented in the latest NixOS or Nixpkgs manuals.
• I assert that this is not a duplicate of an existing documentation issue.
• I assert that I have read the NixOS Code of Conduct and agree to abide by it.

Is this issue important to you?

Add a 👍 reaction to issues you find important.

[PatrickDaG]

Hmm not sure what to do here. The Package just builds the static files needed to host factoriolab. To "run" it, if you can call it that, you just need to use any webserver( nginx, python http.server, etc.) and point it at the built package.

This just feels like to little to warrant an extra documentation section, or module, but I understand your point, if you're not familiar with either the package, or webservers in general it's not obvious what to do with the package.

Not sure what the typical way here is, how to make it clear how the package is meant to be used.

[iedame]

I noticed that the majority of NixOS users are very familiar with programming and how things work, so some stuff gets overlooked when documenting. It wouldn't hurt to have a wiki entry explaining a quick way to start a web server with content from a package like this one.

I guess the most common way to find out how a package works is by searching for "package-name nixos" or just the package name in the wiki.

I can write some simple documentation later, it might be useful in the future so I don't mind doing it.