Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Need to add Satellite README and add Release instructions to Docusaurus #3731

Open
2 tasks
cindyorangis opened this issue Oct 22, 2022 · 7 comments
Open
2 tasks
Labels
area: microservices area: satellite Issues related to the Satellite microservice project developer experience Helping the Developer Experience type: documentation (docs) Improvements or additions to documentation

Comments

@cindyorangis
Copy link
Contributor

cindyorangis commented Oct 22, 2022

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
#3727 (comment)

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

"version": "1.28.0",

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:

@cindyorangis cindyorangis added developer experience Helping the Developer Experience area: microservices area: satellite Issues related to the Satellite microservice project type: documentation (docs) Improvements or additions to documentation labels Oct 22, 2022
@RC-Lee
Copy link
Contributor

RC-Lee commented Oct 22, 2022

Satellite readme

Also related to #3390

To be more specific, release happens in our Continuous Delivery

- run: pnpm -r publish --no-git-checks --access=public

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

@manekenpix
Copy link
Member

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
Copy link
Contributor Author

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

@cindyorangis cindyorangis changed the title Need documentation for Satellite service Need to add Satellite README and add Release instructions to Docusaurus Oct 26, 2022
@humphd
Copy link
Contributor

humphd commented Oct 26, 2022

+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
Copy link
Contributor

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
Copy link
Contributor

humphd commented Jan 20, 2023

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

@SerpentBytes
Copy link
Contributor

SerpentBytes commented Jan 20, 2023

@humphd I can help with this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: microservices area: satellite Issues related to the Satellite microservice project developer experience Helping the Developer Experience type: documentation (docs) Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

6 participants