Chad edits #24
Chad edits #24
Conversation
I'll have more. See the comments
I'll have more. See the comments
…into chad-edits
|
✔️ Deploy Preview for keen-mirzakhani-d40f5e ready! 🔨 Explore the source changes: f700475 🔍 Inspect the deploy log: https://app.netlify.com/sites/keen-mirzakhani-d40f5e/deploys/61d59aced5f4ec00081fda15 😎 Browse the preview: https://deploy-preview-24--keen-mirzakhani-d40f5e.netlify.app |
|
|
||
| ! Don't merge this to the main branch - for observerRTC team discussion | ||
|
|
||
| * CHANGELOG.MD - does that need to be updated? |
| ! Don't merge this to the main branch - for observerRTC team discussion | ||
|
|
||
| * CHANGELOG.MD - does that need to be updated? | ||
| * General commment: too many repos on github.com/ObserveRTC - can these be consolidated so it isn't so overwhelming to a newbie? |
There was a problem hiding this comment.
That's a fair observation.
The main things are in:
- observer: the collector
- sfu-observer-js: client side implementation for sfu sampling
- observer-js: the client-side implementation
less important:
- website: which is this repo
- schemas: for the schema changes. it can be merged with the observer repo
- helm: for kubernetes helm
- docker-compose for docker-compose examples
One idea:
- rename
observer-jstoclient-observer-js, and merge it with the integration repository - rename
schemas-2.0toschemas
Then we should pin the observer, sfu-observer-js, client-observer-js
cc: @pallab-gain
|
|
||
| * CHANGELOG.MD - does that need to be updated? | ||
| * General commment: too many repos on github.com/ObserveRTC - can these be consolidated so it isn't so overwhelming to a newbie? | ||
| * What tool did you use to make your images? |
There was a problem hiding this comment.
I used plantuml!
The source of the images are here: https://github.com/ObserveRTC/observer/tree/master/docs/plantumls
| * What tool did you use to make your images? | ||
| * I moved some items to a new quickstart page at /docs/get-started | ||
| * That quick start could use a a pre-requisites section and video or image showing the output | ||
| * "Observer" vs. "ObserveRTC" - these terms seems to be mixed up (or I lost track of what they are). ObserveRTC - refers to the entire project? |
There was a problem hiding this comment.
yeah. ObserveRTC is for the project, and observer is the server side application collects the samples and generate reports.
| * "Observer" vs. "ObserveRTC" - these terms seems to be mixed up (or I lost track of what they are). ObserveRTC - refers to the entire project? | ||
| * Observer is a specific elment of the project (the one that collects data) | ||
| * It would be better to list Jitsi, mediasoup, peerjs, etc. as sub-menu items with their own pages under client-integrations (and SFU integrations) - | ||
| * I tried this but couldn't figure out how to add an additional submenu in the sidebar - is that possible? |
There was a problem hiding this comment.
which sidebar? the right-hand sidebar automatically created by the table of content of one page (like https://observertc.org/docs/overview/observer/)
the left hand sidebar reflects the folder structure you create. for example
if you create a folder under docs folder like client integration and you put an _index.md under it just like this you have a new category
| * I tried this but couldn't figure out how to add an additional submenu in the sidebar - is that possible? | ||
| * Jitsi is missing from http://localhost:1313/docs/overview/client-integrations/ | ||
| * Is this video still relevant? https://www.youtube.com/watch?v=RZ58vapWfUw&t=23s | ||
| * Do we need a separate site at https://observertc.github.io/ ? |
| * Jitsi is missing from http://localhost:1313/docs/overview/client-integrations/ | ||
| * Is this video still relevant? https://www.youtube.com/watch?v=RZ58vapWfUw&t=23s | ||
| * Do we need a separate site at https://observertc.github.io/ ? | ||
| * What changes need to be made to this graphic?  |
There was a problem hiding this comment.
That is here: https://github.com/ObserveRTC/observer/blob/master/docs/plantumls/overview.puml
if you copy the content of that file for instance here: https://www.planttext.com/ you can see the image and modify the source
| @@ -1,8 +1,8 @@ | |||
| --- | |||
| contributors: {'Balázs Kreith', 'Balazs Kreith'} | |||
| title: "Observer" | |||
| contributors: {'Balázs Kreith', 'Chad Hart'} | |||
There was a problem hiding this comment.
This page is generated by a script.
The original page is here: https://github.com/ObserveRTC/observer/blob/master/docs/user-manual.md
if you modify the source, the script automatically fetch your name as author and the generated page will contain it.
| @@ -14,21 +14,22 @@ images: ["superficial-overview.png", "architecture.png", "object-hierarchy.png", | |||
|
|
|||
| {{< img-simple src="superficial-overview.png" alt="Overview" >}} | |||
|
|
|||
| Observer is a focuspoint for stats object origianted from different part of a WebRTC media services. | |||
| Observer consumes statistics generated from WebRTC end points like browsers and Selective Forwarding Units (SFUs). | |||
There was a problem hiding this comment.
I copied all of these changes to the source page: https://github.com/ObserveRTC/observer/blob/master/docs/user-manual.md
| See the quickstart methodology below for adding this library to your web app. | ||
|
|
||
| ### Janus Quickstart <a name="quickstart"></a> | ||
| ### Janus Quickstart |
There was a problem hiding this comment.
The source of the client-integration is the wiki page like https://github.com/ObserveRTC/integrations/wiki/Vonage-OpenTok-Integration I need to change the script fetching the integration repository and bundle together the integrations into one page.
No description provided.