Code autogenerated from Kurento/doc-kurento@5bb76b3

Makefile

@@ -28,7 +28,7 @@ help:
 	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
 	@echo "  langdoc     to make JavaDocs and JsDocs of the Kurento Clients"
 	@echo "  dist        to make <langdoc html epub latexpdf> and then pack"
-	@echo "              all resulting files as kurento-doc-6.15.0.tgz"
+	@echo "              all resulting files as kurento-doc-6.15.1-dev.tgz"
 	@echo "  readthedocs to make <langdoc> and then copy the results to the"
 	@echo "              Sphinx theme's static folder"
 	@echo ""
@@ -96,7 +96,7 @@ langdoc-utils-js: langdoc-init
 langdoc: langdoc-client-java langdoc-client-js langdoc-utils-js
 
 dist: langdoc html epub latexpdf
-	$(eval DISTDIR := $(BUILDDIR)/dist/kurento-doc-6.15.0)
+	$(eval DISTDIR := $(BUILDDIR)/dist/kurento-doc-6.15.1-dev)
 	mkdir -p $(DISTDIR)
 	rsync -a $(BUILDDIR)/html $(BUILDDIR)/epub/Kurento.epub \
 		$(BUILDDIR)/latex/Kurento.pdf $(DISTDIR)

VERSIONS.conf.sh

@@ -13,7 +13,7 @@
 # shellcheck disable=SC2034
 declare -A PROJECT_VERSIONS=(
     # Version of the documentation itself; it appears in the main menu
-    [VERSION_DOC]="6.15.0"
+    [VERSION_DOC]="6.15.1-dev"
 
     # Version of Kurento Media Server
     [VERSION_KMS]="6.15.0"

source/_extra/robots.txt

@@ -0,0 +1,7 @@
+# Disallow indexing of old documentation versions.
+User-agent: *
+Disallow: /en/*/
+Allow: /en/stable/
+Allow: /en/latest/
+
+Sitemap: https://doc-kurento.readthedocs.io/sitemap.xml

source/_templates/layout.html

@@ -10,17 +10,24 @@
   Add a custom header to all pages, trying to redirect novice users to OpenVidu.
 -->
 {% block document %}
-  <a target="_blank" rel="noopener noreferrer"
-      href="https://openvidu.io/index#features" style="color: #0088aa;">
-    <div style="margin-top: 30px; margin-bottom: 30px; text-align: center;
-        padding: 20px; background-color: rgba(0, 136, 170, 0.05);
-        border: solid 3px #0088aa; border-radius: 4px;">
-      <img src="https://openvidu.io/img/logos/openvidu_vert_grey_bg_transp_cropped.png"
-          style="width: 350px;">
-      <p style="font-size: 19px; margin-top: 20px; margin-bottom: 0;">
-        Discover the new easier way to develop Kurento video applications
-      </p>
-    </div>
-  </a>
-  {{ super() }}
+<!--
+  "admonition" is the class of Warning messages with the current RTD theme.
+  Obtained by directly checking the HTML sources of an already existing block.
+-->
+<div class="admonition warning">
+  <p class="admonition-title">Warning</p>
+  <p>
+    Kurento is a low-level platform to create WebRTC applications from scratch.
+    You will be responsible of managing STUN/TURN servers, networking,
+    scalability, etc. If you are new to WebRTC, we recommend using
+    <a target="_blank" href="https://openvidu.io/">OpenVidu</a> instead.
+  </p>
+  <p>
+    <strong>
+      <a target="_blank" href="https://openvidu.io/">OpenVidu</a> is an easier
+      to use, higher-level, Open Source platform based on Kurento.
+    </strong>
+  </p>
+</div>
+{{ super() }}
 {% endblock %}

source/conf.py

@@ -30,7 +30,7 @@
 # built documents.
 
 # The short X.Y version.
-version = '6.15.0'
+version = '6.15.1-dev'
 
 # The full version, including alpha/beta/rc tags.
 release = version
@@ -121,6 +121,11 @@
 # so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path = ['_static', 'langdoc']
 
+# Add any extra paths that contain custom files (such as robots.txt or
+# .htaccess) here, relative to this directory. These files are copied
+# directly to the root of the documentation.
+html_extra_path = ['_extra']
+
 
 # -- Options for HTMLHelp output ------------------------------------------
 

source/dev/writing_documentation.rst

@@ -192,3 +192,15 @@ In order to overcome this limitation, we opted for the simple solution of handli
 4. Everything is then committed and pushed to this latter repo, thus triggering a new RTD build.
 
 .. _doc-kurento-readthedocs: https://github.com/Kurento/doc-kurento-readthedocs
+
+
+
+robots.txt
+----------
+
+Read the Docs allows setting up a custom **robots.txt**, which we can use to prevent search engines from scrapping old and deprecated versions of the documentation, giving instead full priority to the ``/latest/`` and ``/stable/`` subdirectories in search engines:
+
+* `How can I avoid search results having a deprecated version of my docs? <https://docs.readthedocs.io/en/stable/faq.html#how-can-i-avoid-search-results-having-a-deprecated-version-of-my-docs>`__.
+* `Custom robots.txt Pages <https://docs.readthedocs.io/en/stable/hosting.html#custom-robots-txt-pages>`__.
+
+This is exactly the behavior we want, because without it, searches like "kurento webrtc" would show results from old 6.9 or 6.10 pages, while we'd rather have the latest or stable versions appearing.

source/user/troubleshooting.rst

@@ -708,7 +708,7 @@ If you are trying to generate a video recording, keep in mind that **the endpoin
 
 .. ifconfig:: "false" == "true"
 
-   Quoting from the `Client documentation <https://doc-kurento.readthedocs.io/en/6.15.0/_static/client-javadoc/org/kurento/client/RecorderEndpoint.html>`__:
+   Quoting from the `Client documentation <https://doc-kurento.readthedocs.io/en/6.15.1-dev/_static/client-javadoc/org/kurento/client/RecorderEndpoint.html>`__:
 
 .. ifconfig:: "false" != "true"