open-horizon.github.io icon indicating copy to clipboard operation
open-horizon.github.io copied to clipboard

Determine the fate of Software Defined Radio example documentation

Open johnwalicki opened this issue 2 years ago • 1 comments

The SDR example has depreciated the cloud functions components. This caused several broken links in the OH Docs ( See #350 ) I opened a PR ( #357 ) to remove the SDR Cloud links and sections.

The remaining SDR example documentation page is somewhat half useful. We should decide on the fate of this page...

I see two possible paths forward:

  • Sunset the docs markdown and move some of the remaining readme markdown pieces over to the SDR examples directory (linked above)
  • Improve the SDR doc to showcase what you can do with Event Streams (or convert to MQTT and subscribe a Node-RED flow to it)

johnwalicki avatar Nov 29 '22 15:11 johnwalicki

The OH Docs does not highlight many / any other OH Examples. Why was this specific example documented?

One could argue that we should sunset the OH Docs software_defined_radio_ex.md page and move the docs over to SDR example repo/directory.

johnwalicki avatar Nov 29 '22 15:11 johnwalicki

Sunset the docs markdown and move some of the remaining readme markdown pieces over to the SDR examples directory

Second action team ... LINK to new open-horizon-services hello word distributed application

t-fine avatar Jan 03 '23 16:01 t-fine

We can also move the SVG image to the examples SDR repo and delete it from the OH Docs repo.

https://github.com/open-horizon/open-horizon.github.io/blob/master/docs/images/edge/08_sdrarch.svg

johnwalicki avatar Jan 04 '23 03:01 johnwalicki

@t-fine - Can you review this issue? I think the final step is to :

  • In the Docs repo, delete the https://github.com/open-horizon/open-horizon.github.io/blob/master/docs/images/edge/08_sdrarch.svg
  • In the Docs repo, delete the https://github.com/open-horizon/open-horizon.github.io/blob/master/docs/installing/software_defined_radio_ex.md
  • Remove a reference to the software_defined_radion_ex.md that appears in
using_edge_services/additional_examples.md:* [Software-defined radio edge processing](../installing/software_defined_radio_ex.md)

johnwalicki avatar Feb 14 '23 17:02 johnwalicki

We need to confirm with @Rene-Ch1 that the 08_sdrarch.svg is NOT used by this downstream document: https://www.ibm.com/docs/en/eam/4.4?topic=examples-software-defined-radio-edge-processing

johnwalicki avatar Feb 20 '23 04:02 johnwalicki