Create Telescope Architecture Diagram

[cindyorangis]

Following the architecture doc that was added in #2662, we should create an architecture diagram to go along with the written doc.

Here is a janky diagram I made after the doc was added because it was exciting but it has been neglected since... this was the state of Telescope in Release 2.5. Obviously, it is incomplete and many things new features have been added since 2.5 such as Supabase, React Native, Docusaurus, etc.

Missing items:

• Gitwork flow is incomplete
• Gitpod
• Vercel
• Supabase,
• React Native
• Docusaurus
• Dependency Discovery
• Icons needed

[humphd]

This ls looking amazing! We need to update a few things:

• our main router (where you have SSL) is nginx, which we should name here
• nginx routes to api.*/v1/* for microservices
• we also route to some other things at the nginx level (docs, portainer, the next.js app, etc). In other words, Traefik only routes to a subset of containers, not everything
• we have a whole bunch of new Supabase containers that are also running inside our microservices layer

Question: is the source of this diagram something we can check into git, so we can maintain it, or only the finished product?

[cindyorangis]

Question: is the source of this diagram something we can check into git, so we can maintain it, or only the finished product?

I made this in Figma and exported it as a .jpeg file. I don't know how we can check this into git but we should probably explore how it can be done since we'll be making changes to the diagram often

cc @sirinoks since she mentioned she working on this https://github.com/Seneca-CDOT/telescope/pull/2662#issuecomment-1019308190

[sirinoks]

@cindyledev What other file types can you export it as? I'm not familiar with Figma myself, but if that's the only option, I can learn it.

[cindyorangis]

@cindyledev What other file types can you export it as? I'm not familiar with Figma myself, but if that's the only option, I can learn it.

.png, .jpg, .pdf

I can send you the Figma file so you have it locally, it's a .jam file

[sirinoks]

@cindyledev I can work with PDFs in Illustrator theoretically

[cindyorangis]

@sirinoks I don't know if you wanna redo the whole thing because when I was making the diagram, I didn't account for resolution or screen sizes so the image is terrible. It's a REALLY rough draft

[sirinoks]

@cindyledev So I want to it have a color coded format that's also linked to label colors and have generally design and shit, so that's my focus. But I don't know all the components, and I know we have some missing components to add.

[cindyorangis]

Let's see if we can use mermaid.js here

[cindyorangis]

Depends on #2960 . Once it gets resolved, we can move forward with this.