Add link to the documentation for live streaming

6 files changed, 27 insertions, 2 deletions

diff --git a/client/src/app/+videos/+video-edit/shared/video-edit.component.html b/client/src/app/+videos/+video-edit/shared/video-edit.component.html
index 0c60ec4ec..d75f37074 100644
--- a/client/src/app/+videos/+video-edit/shared/video-edit.component.html
+++ b/client/src/app/+videos/+video-edit/shared/video-edit.component.html
@@ -210,6 +210,9 @@
       <ng-template ngbNavContent>
         <div class="row live-settings">
           <div class="col-md-12">
+            <div class="alert alert-info">
+              <my-live-documentation-link></my-live-documentation-link>
+            </div>
 
             <div class="form-group">
               <label for="liveVideoRTMPUrl" i18n>Live RTMP Url</label>
diff --git a/client/src/app/menu/menu.component.scss b/client/src/app/menu/menu.component.scss
index 89dc26e87..f369fa17a 100644
--- a/client/src/app/menu/menu.component.scss
+++ b/client/src/app/menu/menu.component.scss
@@ -192,6 +192,7 @@ menu {
         .logged-in-username {
           font-size: 13px;
           color: #C6C6C6;
+          margin-top: 3px;
         }
       }
     }
diff --git a/client/src/app/shared/shared-video-live/live-documentation-link.component.html b/client/src/app/shared/shared-video-live/live-documentation-link.component.html
new file mode 100644
index 000000000..0c54c7044
--- /dev/null
+++ b/client/src/app/shared/shared-video-live/live-documentation-link.component.html
@@ -0,0 +1,4 @@
+<div i18n>
+  See <a href="https://docs.joinpeertube.org/#/use-create-upload-video?id=publish-a-live-in-peertube-gt-v3" target="_blank" rel="noopener noreferrer">the documentation</a>
+  to learn how to use the PeerTube live streaming feature.
+</div>
diff --git a/client/src/app/shared/shared-video-live/live-documentation-link.component.ts b/client/src/app/shared/shared-video-live/live-documentation-link.component.ts
new file mode 100644
index 000000000..be4006ce8
--- /dev/null
+++ b/client/src/app/shared/shared-video-live/live-documentation-link.component.ts
@@ -0,0 +1,10 @@
+import { Component } from '@angular/core'
+
+@Component({
+  selector: 'my-live-documentation-link',
+  templateUrl: './live-documentation-link.component.html',
+  styleUrls: [ ]
+})
+export class LiveDocumentationLinkComponent {
+
+}
diff --git a/client/src/app/shared/shared-video-live/live-stream-information.component.html b/client/src/app/shared/shared-video-live/live-stream-information.component.html
index 8d9467fe5..e7b00cd01 100644
--- a/client/src/app/shared/shared-video-live/live-stream-information.component.html
+++ b/client/src/app/shared/shared-video-live/live-stream-information.component.html
@@ -11,6 +11,10 @@
       <div class="badge badge-info" *ngIf="live.saveReplay" i18n>Replay will be saved</div>
     </div>
 
+    <div class="alert alert-info">
+      <my-live-documentation-link></my-live-documentation-link>
+    </div>
+
     <div class="form-group">
       <label for="liveVideoRTMPUrl" i18n>Live RTMP Url</label>
       <my-input-toggle-hidden id="liveVideoRTMPUrl" [value]="live.rtmpUrl" [withToggle]="false" [withCopy]="true" [show]="true" [readonly]="true"></my-input-toggle-hidden>
diff --git a/client/src/app/shared/shared-video-live/shared-video-live.module.ts b/client/src/app/shared/shared-video-live/shared-video-live.module.ts
index c35c2caa3..f5e153ac9 100644
--- a/client/src/app/shared/shared-video-live/shared-video-live.module.ts
+++ b/client/src/app/shared/shared-video-live/shared-video-live.module.ts
@@ -3,6 +3,7 @@ import { NgModule } from '@angular/core'
 import { SharedFormModule } from '../shared-forms'
 import { SharedGlobalIconModule } from '../shared-icons'
 import { SharedMainModule } from '../shared-main/shared-main.module'
+import { LiveDocumentationLinkComponent } from './live-documentation-link.component'
 import { LiveStreamInformationComponent } from './live-stream-information.component'
 import { LiveVideoService } from './live-video.service'
 
@@ -14,11 +15,13 @@ import { LiveVideoService } from './live-video.service'
   ],
 
   declarations: [
-    LiveStreamInformationComponent
+    LiveStreamInformationComponent,
+    LiveDocumentationLinkComponent
   ],
 
   exports: [
-    LiveStreamInformationComponent
+    LiveStreamInformationComponent,
+    LiveDocumentationLinkComponent
   ],
 
   providers: [