JSON_Bourne: Documentation please!

ISISComputingGroup / IBEX

JSON_Bourne: Documentation please! #1787

Closed AdrianPotter closed 7 years ago

AdrianPotter commented 8 years ago

As far as I can see, there is currently no developer documentation for JSON_Bourne. This means that when Dom and Thomas are out of the office, nobody knows how it works! Combined with ticket #1786 the instrument setup of the web server is opaque. We should not be in a situation where knowledge is restricted to specific parts of the team such that development cannot continue without them. Please make sure that the basics of JSON_Bourne are documented.

DominicOram commented 8 years ago

Documentation is here https://github.com/ISISComputingGroup/ibex_developers_manual/wiki/Web-Dashboard. Granted, it wasn't obvious how to get to it and it's ever so slightly out of date (the diagram especially). This ticket should be used to fix this.

DominicOram commented 8 years ago

Documentation should now be clearer and linked to from the homepage

AdrianPotter commented 8 years ago

Thanks for linking. After reading the documentation I am unclear on:

How to update the extweb. Presumably it has a machine name and standard network credentials?
How to run the server locally for developer purposes. Is it a case of starting the server and then navigating to localhost:60000/default.html?instrument=NDW[INST]? It'd be good if that was explicit

Also please link to the git repo in the developer notes so a beginner developer knows where to clone from

DominicOram commented 8 years ago

Updated docs at https://github.com/ISISComputingGroup/ibex_developers_manual/wiki/Web-Dashboard. This also now links to https://github.com/ISISComputingGroup/ibex_developers_manual/wiki/Deployment-on-an-Instrument-Control-PC#add-instrument-to-ibex-web-dashboard.