Need to add Satellite README and add Release instructions to Docusaurus

[cindyorangis]

Where is the problem?

• [ ] Link comment/file/somewhere else
• [ ] Screenshot

What exactly is wrong: We need to add the Satellite README to Docusaurus https://github.com/Seneca-CDOT/telescope/blob/253b8d60216194fb43d4d63dc649ae56ab06de2b/src/satellite/README.md

and add how to do a release

According to @RC-Lee, this is how you would ship a new version of Satellite https://github.com/Seneca-CDOT/telescope/issues/3727#issuecomment-1287237686

For making a Satellite release, we only have to change the version here

https://github.com/Seneca-CDOT/telescope/blob/e10b0ea1f1f453e7146c1808fe54c28d0f98ea3f/src/satellite/package.json#L3

make a PR, and merge to master, Then make another PR for all the services to use the latest Satellite. Can have renovate do it, but probably better to do it manually to see nothing breaks with the node upgrades.

What should it be instead:

[RC-Lee]

Satellite readme

Also related to #3390

To be more specific, release happens in our Continuous Delivery https://github.com/Seneca-CDOT/telescope/blob/1760847aaad05c6fa90768e70a2590c6b995f8d1/.github/workflows/pnpm-publish.yml#L29

For example https://github.com/Seneca-CDOT/telescope/actions/runs/3194140138/jobs/5213406901#step:6:1

[manekenpix]

So, what's the action required in this issue? It seems (as mentioned in @RC-Lee's comment) that satellite has a good README. Should this issue specify that we want to add docs in docusaurus? do we think a README is enough and we don't need a docusaurus section? and, if that's the case, should we repurpose this issue for documenting how to release a new version of satellite?

[cindyorangis]

I think we should add this README to Docusaurus and document how to release a new version of Satellite. I'll update the issue title and description

[humphd]

+1 for adding the README as a doc in the docs site. We can extend it thereafter. I'd probably also update the README file in the source tree to not duplicate things (i.e., make it a link to the docs site or something).

[sirinoks]

Document how to release a new version of Satellite

I can do a doc, but I don't know the actual information. Who would be people to ask about that?

[humphd]

@SerpentBytes is working on Satellite related bits, and might be able to help with this some time down the road.

[SerpentBytes]

@humphd I can help with this.