From a3a0bba93a38f32cf2d640375110326b12d83fa0 Mon Sep 17 00:00:00 2001 From: mbm_1607 Date: Sat, 18 May 2024 15:33:34 +0500 Subject: [PATCH] Fix the documentation image attachments Fixes https://github.com/bigbluebutton/bigbluebutton/issues/20297 --- docs/docs/development/architecture.md | 4 ++-- docs/docs/development/recording.md | 10 +++++----- ...-conversion-diagram-general-conversion-flow.png} | Bin ...tion-conversion-diagram-svg-conversion-flow.png} | Bin ...tion-conversion-diagram-swf-conversion-flow.png} | Bin ...rd-and-playback-service-diagram-rap-archive.png} | Bin ...d-and-playback-service-diagram-rap-overview.png} | Bin ...rd-and-playback-service-diagram-rap-process.png} | Bin ...rd-and-playback-service-diagram-rap-publish.png} | Bin ...ord-and-playback-service-diagram-rap-sanity.png} | Bin 10 files changed, 7 insertions(+), 7 deletions(-) rename docs/static/img/diagrams/{Presentation Conversion Diagram-General Conversion Flow.png => presentation-conversion-diagram-general-conversion-flow.png} (100%) rename docs/static/img/diagrams/{Presentation Conversion Diagram-SVG Conversion Flow.png => presentation-conversion-diagram-svg-conversion-flow.png} (100%) rename docs/static/img/diagrams/{Presentation Conversion Diagram-SWF Conversion Flow.png => presentation-conversion-diagram-swf-conversion-flow.png} (100%) rename docs/static/img/diagrams/{Record and Playback Service Diagram-RAP - Archive.png => record-and-playback-service-diagram-rap-archive.png} (100%) rename docs/static/img/diagrams/{Record and Playback Service Diagram-RAP - Overview.png => record-and-playback-service-diagram-rap-overview.png} (100%) rename docs/static/img/diagrams/{Record and Playback Service Diagram-RAP - Process.png => record-and-playback-service-diagram-rap-process.png} (100%) rename docs/static/img/diagrams/{Record and Playback Service Diagram-RAP - Publish.png => record-and-playback-service-diagram-rap-publish.png} (100%) rename docs/static/img/diagrams/{Record and Playback Service Diagram-RAP - Sanity.png => record-and-playback-service-diagram-rap-sanity.png} (100%) diff --git a/docs/docs/development/architecture.md b/docs/docs/development/architecture.md index 7725a5f294..8e366303dc 100644 --- a/docs/docs/development/architecture.md +++ b/docs/docs/development/architecture.md @@ -132,11 +132,11 @@ The conversion process sends progress messages to the client through the Redis p The diagram below describes the flow of the presentation conversion. We take in consideration the configuration for enabling and disabling SWF, SVG and PNG conversion. -![General Conversion Flow](/img/diagrams/Presentation Conversion Diagram-General Conversion Flow.png) +![General Conversion Flow](/img/diagrams/presentation-conversion-diagram-general-conversion-flow.png) Then below the SVG conversion flow. It covers the conversion fallback. Sometimes we detect that the generated SVG file is heavy to load by the browser, we use the fallback to put a rasterized image inside the SVG file and make its loading light for the browser. -![SVG Conversion Flow](/img/diagrams/Presentation Conversion Diagram-SVG Conversion Flow.png) +![SVG Conversion Flow](/img/diagrams/presentation-conversion-diagram-svg-conversion-flow.png) ### Internal network connections diff --git a/docs/docs/development/recording.md b/docs/docs/development/recording.md index 279424964a..2fd5e4826c 100644 --- a/docs/docs/development/recording.md +++ b/docs/docs/development/recording.md @@ -27,7 +27,7 @@ After the session finishes, the BigBlueButton server will run an archive script After the recording is archived, BigBlueButton will run one (or more) ingest and processing scripts, named workflows, that will _process_ and _publish_ the captured data into a format for _playback_. -![Record and Playback - Overview](/img/diagrams/Record and Playback Service Diagram-RAP - Overview.png) +![Record and Playback - Overview](/img/diagrams/record-and-playback-service-diagram-rap-overview.png) ## Record and Playback Phases @@ -50,26 +50,26 @@ Whiteboard, cursor, chat and other events are stored on Redis. Webcam videos (.f The Archive phase involves placing the captured media and events into a **raw** directory. That directory contains ALL the necessary media and files to work with. -![Record and Playback - Archive](/img/diagrams/Record and Playback Service Diagram-RAP - Archive.png) +![Record and Playback - Archive](/img/diagrams/record-and-playback-service-diagram-rap-archive.png) ### Sanity The Sanity phase involves checking that all the archived files are _valid_ for processing. For example that media files have not zero length and events were archived. -![Record and Playback - Sanity](/img/diagrams/Record and Playback Service Diagram-RAP - Sanity.png) +![Record and Playback - Sanity](/img/diagrams/record-and-playback-service-diagram-rap-sanity.png) ### Process The Process phase involves processing the valid archived files of the recording according to the workflow (e.g., presentation). Usually, it involves parsing the archived events, converting media files to other formats or concatenating them, etc. -![Record and Playback - Process](/img/diagrams/Record and Playback Service Diagram-RAP - Process.png) +![Record and Playback - Process](/img/diagrams/record-and-playback-service-diagram-rap-process.png) ### Publish The Publish phase involves generating metadata and taking many or all the processed files and placing them in a directory exposed publicly for later playback. -![Record and Playback - Publish](/img/diagrams/Record and Playback Service Diagram-RAP - Publish.png) +![Record and Playback - Publish](/img/diagrams/record-and-playback-service-diagram-rap-publish.png) ### Post-Scripts diff --git a/docs/static/img/diagrams/Presentation Conversion Diagram-General Conversion Flow.png b/docs/static/img/diagrams/presentation-conversion-diagram-general-conversion-flow.png similarity index 100% rename from docs/static/img/diagrams/Presentation Conversion Diagram-General Conversion Flow.png rename to docs/static/img/diagrams/presentation-conversion-diagram-general-conversion-flow.png diff --git a/docs/static/img/diagrams/Presentation Conversion Diagram-SVG Conversion Flow.png b/docs/static/img/diagrams/presentation-conversion-diagram-svg-conversion-flow.png similarity index 100% rename from docs/static/img/diagrams/Presentation Conversion Diagram-SVG Conversion Flow.png rename to docs/static/img/diagrams/presentation-conversion-diagram-svg-conversion-flow.png diff --git a/docs/static/img/diagrams/Presentation Conversion Diagram-SWF Conversion Flow.png b/docs/static/img/diagrams/presentation-conversion-diagram-swf-conversion-flow.png similarity index 100% rename from docs/static/img/diagrams/Presentation Conversion Diagram-SWF Conversion Flow.png rename to docs/static/img/diagrams/presentation-conversion-diagram-swf-conversion-flow.png diff --git a/docs/static/img/diagrams/Record and Playback Service Diagram-RAP - Archive.png b/docs/static/img/diagrams/record-and-playback-service-diagram-rap-archive.png similarity index 100% rename from docs/static/img/diagrams/Record and Playback Service Diagram-RAP - Archive.png rename to docs/static/img/diagrams/record-and-playback-service-diagram-rap-archive.png diff --git a/docs/static/img/diagrams/Record and Playback Service Diagram-RAP - Overview.png b/docs/static/img/diagrams/record-and-playback-service-diagram-rap-overview.png similarity index 100% rename from docs/static/img/diagrams/Record and Playback Service Diagram-RAP - Overview.png rename to docs/static/img/diagrams/record-and-playback-service-diagram-rap-overview.png diff --git a/docs/static/img/diagrams/Record and Playback Service Diagram-RAP - Process.png b/docs/static/img/diagrams/record-and-playback-service-diagram-rap-process.png similarity index 100% rename from docs/static/img/diagrams/Record and Playback Service Diagram-RAP - Process.png rename to docs/static/img/diagrams/record-and-playback-service-diagram-rap-process.png diff --git a/docs/static/img/diagrams/Record and Playback Service Diagram-RAP - Publish.png b/docs/static/img/diagrams/record-and-playback-service-diagram-rap-publish.png similarity index 100% rename from docs/static/img/diagrams/Record and Playback Service Diagram-RAP - Publish.png rename to docs/static/img/diagrams/record-and-playback-service-diagram-rap-publish.png diff --git a/docs/static/img/diagrams/Record and Playback Service Diagram-RAP - Sanity.png b/docs/static/img/diagrams/record-and-playback-service-diagram-rap-sanity.png similarity index 100% rename from docs/static/img/diagrams/Record and Playback Service Diagram-RAP - Sanity.png rename to docs/static/img/diagrams/record-and-playback-service-diagram-rap-sanity.png