Attention is currently required from: osmith, pespin.
fixeria has posted comments on this change by fixeria. ( https://gerrit.osmocom.org/c/erlang/osmo-s1gw/+/42364?usp=email )
Change subject: doc/manuals: add overview, document running and configuration ......................................................................
Patch Set 5:
(7 comments)
File README.md:
https://gerrit.osmocom.org/c/erlang/osmo-s1gw/+/42364/comment/adb78ef2_930bc... : PS4, Line 131: `make install` deploys a complete ERTS release together with a convenience
the edits in this line until the end of this section don't seem like improvements to me, it just add […]
Acknowledged
File doc/manuals/chapters/overview.adoc:
https://gerrit.osmocom.org/c/erlang/osmo-s1gw/+/42364/comment/d8e5288d_c03cf... : PS4, Line 9: , i.e. radio base stations
seems unnecessary, people reading this should be familiar with what an eNodeB is, so I suggest to re […]
Acknowledged
https://gerrit.osmocom.org/c/erlang/osmo-s1gw/+/42364/comment/c1ff35c8_b90a2... : PS4, Line 38: ----
instead of such ascii art diagrams, we typically use graphviz graphs in manuals: https://gitea. […]
I tend to have problems with graphviz placing the graph elements randomly. I did my best here and (at least in https://dreampuf.github.io/GraphvizOnline/?engine=dot) the new diagram looks good.
File doc/manuals/chapters/running.adoc:
https://gerrit.osmocom.org/c/erlang/osmo-s1gw/+/42364/comment/c4256df6_40d82... : PS4, Line 32: Useful for testing new features or bug fixes before they are formally released.
Given that this is project specific documentation, I would remove above block starting with "Two pac […]
Acknowledged
https://gerrit.osmocom.org/c/erlang/osmo-s1gw/+/42364/comment/7cc5aabd_a4800... : PS4, Line 107: Running `make install` (typically as root, or with `DESTDIR` set for
This is very verbose. […]
Acknowledged, removed.
https://gerrit.osmocom.org/c/erlang/osmo-s1gw/+/42364/comment/f7ee711a_4629f... : PS4, Line 128: ==== The `osmo-s1gw` Bootstrap Script
This is also very verbose. […]
I see no problem with explaining what the bootstrap script does and including the help message here. Especially given that osmo-s1gw is currently the only project that installs a release package and brings a bootstrap script (others install a escript instead). And the arguments of `osmo-s1gw.sh` are unlikely to be added/modified often.
https://gerrit.osmocom.org/c/erlang/osmo-s1gw/+/42364/comment/8d6a1432_d1897... : PS4, Line 198: Wireshark and are tagged with the application name `OsmoS1GW`.
why is this worth mentioning? " and are tagged with the application name `OsmoS1GW`. […]
Acknowledged