Build of r/13.x from Sat Oct 28 05:21:08 UTC 2023

opencast · Oct 28, 2023 · baed6c4 · baed6c4
1 parent 2ae67e0
commit baed6c4
Show file tree

Hide file tree

Showing 9 changed files with 37 additions and 54 deletions.
diff --git a/r/13.x/admin/index.html b/r/13.x/admin/index.html
@@ -803,5 +803,5 @@ <h2 id="release-documentation">Release Documentation</h2>
 </html>
 <!--
 MkDocs version : 1.5.3
-Build Date UTC : 2023-10-27 10:33:35.426857+00:00
+Build Date UTC : 2023-10-28 05:20:50.822913+00:00
 -->
diff --git a/r/13.x/admin/modules/youtubepublication/index.html b/r/13.x/admin/modules/youtubepublication/index.html
@@ -37,7 +37,7 @@
               {title: "Before you start", url: "#before-you-start" },
               {title: "Google Developers Configuration", url: "#google-developers-configuration" },
               {title: "YouTube configuration in Opencast", url: "#youtube-configuration-in-opencast" },
-              {title: "Activate YouTube publication in Opencast", url: "#activate-youtube-publication-in-opencast" },
+              {title: "Add YouTube publication to your Opencast workflows", url: "#add-youtube-publication-to-your-opencast-workflows" },
           ]},
         ];
 
@@ -94,32 +94,42 @@ <h2 id="before-you-start">Before you start</h2>
 <p>You need to meet these requirements to make a YouTube Publication:</p>
 <ul>
 <li>Google Account</li>
-<li>YouTube Channel to make the publication</li>
+<li>YouTube Channel to publish to</li>
 </ul>
 <h2 id="google-developers-configuration">Google Developers Configuration</h2>
 <p>Below is a summarized version of <a href="https://developers.google.com/youtube/registering_an_application">Google's quickstart page</a>.  If these
 instructions do not work for you, or are unclear please let us know - Google has a habit of changing its configuration
 pages and we don't always notice!</p>
 <h3 id="create-new-google-project">Create new Google Project</h3>
 <ul>
-<li>Login to Google account</li>
+<li>Login to your Google account</li>
 <li>Navigate to the <a href="https://console.developers.google.com/project"><strong>Google Developers Console</strong></a></li>
 <li>Click <strong>Create Project</strong> and follow the instructions</li>
 <li>Navigate to the <a href="https://console.developers.google.com/apis/credentials"><strong>Google Credentials Console</strong></a></li>
 <li>Select <strong>OAuth consent screen</strong></li>
-<li>Configure the API Consent Screen, you will need to set the Product name</li>
+<li>Configure the API Consent Screen<ul>
+<li>For <strong>User type</strong> select <code>external</code></li>
+<li>Add a test user (only necessary if your app is still in testing mode)</li>
+<li>Fill in the rest of the required settings at discretion</li>
+</ul>
+</li>
 <li>Select <strong>Credentials</strong></li>
-<li>Select <strong>Create Credentials</strong>, specifically OAuth Client ID</li>
-<li>Select <strong>Other</strong> application type</li>
+<li>Select <strong>Create Credentials</strong>, specifically OAuth Client ID<ul>
+<li><strong>Application type</strong> must be set to <code>Desktop</code></li>
+</ul>
+</li>
 </ul>
 <h3 id="save-client-id-in-json-format">Save Client ID in JSON Format</h3>
 <ul>
+<li>Select <strong>Credentials</strong>, you should see a new entry in the <strong>OAuth 2.0 Client IDs</strong> table</li>
 <li>Download the client information in JSON format by clicking <strong>Download JSON</strong><ul>
 <li>This currently looks like an arrow pointing downwards on the rightmost portion of the client id row</li>
 </ul>
 </li>
 <li>Save the JSON file to <code>${karaf.etc}/youtube-v3/client-secrets-youtube-v3.json</code> (Usually this is
-  <code>etc/youtube-v3/client-secrets-youtube-v3.json</code>)</li>
+  <code>etc/youtube-v3/client-secrets-youtube-v3.json</code>). It should match the path configured for
+  <code>org.opencastproject.publication.youtube.clientSecretsV3</code> in
+  <code>org.opencastproject.publication.youtube.YouTubeV3PublicationServiceImpl.cfg</code>.</li>
 </ul>
 <h3 id="enable-api">Enable API</h3>
 <ul>
@@ -136,7 +146,7 @@ <h2 id="youtube-configuration-in-opencast">YouTube configuration in Opencast</h2
 <p>With the JSON file created and saved previously, you have to proceed as described:</p>
 <ul>
 <li>
-<p>Start Opencast server (Restart Opencast in case was running)</p>
+<p>Start Opencast server (Restart Opencast in case it was running)</p>
 <p><strong>Note:</strong> Until this service is fully configured, Opencast will not start completely. In case you
 want to abort the configuration, you only need to delete the JSON file and restart Opencast.</p>
 </li>
@@ -163,38 +173,12 @@ <h2 id="youtube-configuration-in-opencast">YouTube configuration in Opencast</h2
 <p>Restart Opencast</p>
 </li>
 </ul>
-<h2 id="activate-youtube-publication-in-opencast">Activate YouTube publication in Opencast</h2>
-<p>Opencast can now publish to YouTube. The last step is to activate this feature. For this you have to create a new
-workflow or modify an existing one.</p>
-<ul>
-<li>
-<p>Open the workflows <code>etc/opencast/workflows/ng-schedule-and-upload.xml</code> and <code>etc/opencast/workflows/ng-publish.xml</code></p>
-</li>
-<li>
-<p>In the file, modify the <code>&lt;configuration_panel&gt;</code> and enable the YouTube option, like this:</p>
-<pre><code>&lt;input id="publishToYouTube" name="publishToYouTube" type="checkbox" class="configField" value="true"
-       disabled="disabled" /&gt;
-</code></pre>
-</li>
-</ul>
-<p>becomes</p>
-<pre><code>    &lt;input id="publishToYouTube" name="publishToYouTube" type="checkbox" class="configField" value="true"/&gt;
-</code></pre>
-<ul>
-<li>
-<p>Open the workflows <code>etc/opencast/workflows/ng-retract.xml</code></p>
-</li>
-<li>
-<p>In the file, modify the <code>&lt;configuration_panel&gt;</code> and enable the YouTube option, like this:</p>
-<pre><code>&lt;input id="retractFromYouTube" type="checkbox" class="configField" value="true" disabled="disabled" /&gt;
-</code></pre>
-</li>
-</ul>
-<p>becomes</p>
-<pre><code>    &lt;input id="retractFromYouTube" type="checkbox" checked="checked" class="configField" value="true" /&gt;
-</code></pre>
-<p>Opencast will detect the new workflow without restart, with that you can select the new workflow with the YouTube option
-enabled.</p>
+<h2 id="add-youtube-publication-to-your-opencast-workflows">Add YouTube publication to your Opencast workflows</h2>
+<p>Opencast can now publish to YouTube. To make use of this, add the <a href="../../workflowoperationhandlers/publish-youtube-woh/">Publish YouTube workflow operation</a>
+to your Opencast workflows. You can find more details on how to use the operation on its <a href="(../workflowoperationhandlers/publish-youtube-woh.md)">own page</a>.
+In general, it should be placed near your other <code>publish</code> operations.</p>
+<p>You may also want to add the <a href="../../workflowoperationhandlers/retract-youtube-woh/">Retract YouTube workflow operation</a> 
+near your <code>retract</code> operations.</p>
 
   <br>
 

diff --git a/r/13.x/admin/search/search_index.json b/r/13.x/admin/search/search_index.json
diff --git a/r/13.x/admin/sitemap.xml.gz b/r/13.x/admin/sitemap.xml.gz
diff --git a/r/13.x/admin/workflowoperationhandlers/publish-youtube-woh/index.html b/r/13.x/admin/workflowoperationhandlers/publish-youtube-woh/index.html
@@ -90,10 +90,10 @@
     <h1 id="publish-youtube-workflow-operation">Publish YouTube Workflow Operation</h1>
 <p>ID: <code>publish-youtube</code></p>
 <h2 id="description">Description</h2>
-<p>The publish YouTube operation publishes a single stream to YouTube.  This stream must meet YouTube's format
-requirements, and may consist of audio and/or video.  If you want to publish both your presenter and presentation
+<p>The publish YouTube operation publishes a single stream to YouTube. This stream must meet YouTube's format
+requirements, and may consist of one audio and/or video stream. If you want to publish both your presenter and presentation
 streams we suggest using the <a href="../composite-woh/">Composite</a> workflow operation handler to prepare a composite file
-with both streams inside of it.  The default Opencast workflow prepares a video using this method.</p>
+with both streams inside of it.  </p>
 <h2 id="parameter-table">Parameter Table</h2>
 <table>
 <thead>

diff --git a/r/13.x/admin/workflowoperationhandlers/retract-youtube-woh/index.html b/r/13.x/admin/workflowoperationhandlers/retract-youtube-woh/index.html
@@ -90,7 +90,7 @@ <h1 id="retract-youtube-workflow-operation">Retract Youtube Workflow Operation</
 <p>ID: <code>retract-youtube</code></p>
 <h2 id="description">Description</h2>
 <p>The retract YouTube operation retracts the published elements from YouTube.
-There are no configuration keys at this time.</p>
+There are no configuration keys.</p>
 <h2 id="operation-example">Operation Example</h2>
 <pre><code class="language-xml">&lt;operation
   id=&quot;retract-youtube&quot;

diff --git a/r/13.x/commit b/r/13.x/commit
@@ -1,10 +1,9 @@
-commit 0e249ea6433d5e7fa6b4cb9b02ee859b5dbfe329
-Author: Katrin Ihler <[email protected]>
-Date:   Fri Oct 27 12:33:01 2023 +0200
+commit 50af946ca774072d2a96ddec792777f2f8ae0789
+Author: Greg Logan <[email protected]>
+Date:   Fri Oct 27 20:04:56 2023 -0600
 
-    Fix external api listprovider header (#5344)
+    Merge branch 'update-youtube-publication-documentation' of Arnei/opencast into r/13.x
 
-    Aims at fixing  #5308.
+    Pull request #5348
 
-    Since this is only fixes wrong behaviour, I dare say we do not need a
-    new external api version to make these fixes.
+      Update Youtube Publication documentation
diff --git a/r/13.x/developer/index.html b/r/13.x/developer/index.html
@@ -422,5 +422,5 @@ <h1 id="opencast-development-guides">Opencast Development Guides</h1>
 </html>
 <!--
 MkDocs version : 1.5.3
-Build Date UTC : 2023-10-27 10:33:37.637407+00:00
+Build Date UTC : 2023-10-28 05:20:52.922201+00:00
 -->
diff --git a/r/13.x/developer/sitemap.xml.gz b/r/13.x/developer/sitemap.xml.gz