nanovms / ops

ops - build and run nanos unikernels
https://ops.city
MIT License
1.27k stars 132 forks source link

Incomplete documentation, no real world nodejs runner example #1575

Closed kyeno closed 7 months ago

kyeno commented 7 months ago

The documentation is both incomplete and incoherent.

There are at least two links leading to 404s:

Screenshot_select-area_20240203142439 Screenshot_select-area_20240203143122

The first one (with nodejs examples) is rather IMPORTANT to work; otherwise the whole documentation treats that usecase rather poorly.

Undocumented configuration option: Screenshot_select-area_20240203142759

Generally it's very hard to "get started" with a real world node project here (something bigger than "hello world" one) and I believe that section should be vastly expanded.

eyberg commented 7 months ago

thanks for pointing it out - there are quite a few javascript examples here: https://github.com/nanovms/ops-examples/tree/master/javascript and we should probably rename the 'getting started' - there are some for just normal users and some for those working on nanos itself

eyberg commented 7 months ago

https://github.com/nanovms/ops-documentation/commit/fa29ee1dcb95ed5b8d28ef2fc8169f37e712b5fe https://github.com/nanovms/ops-documentation/commit/3bd054ee25f13a356f39d42fe742a2da47e75a63