Add extension to create sitemaps (#547)

Adding sitemap generator extension and a sitemap_index.xml file we can share with the web site team.

package.json

@@ -13,7 +13,7 @@
     "type": "git",
     "url": "git+https://github.com/minio/docs.git"
   },
-  "author": "Ravind Kumar",
+  "author": "MinIO Documentation Team",
   "license": "Apache-2.0",
   "bugs": {
     "url": "https://github.com/minio/docs/issues"

requirements.txt

@@ -1,9 +1,10 @@
-docutils == 0.18
+docutils == 0.17
 sphinx == 4.3.2
 sphinx-copybutton == 0.5.0
 sphinx-design == 0.2.0
 sphinx-markdown-tables == 0.0.15
 Sphinx-Substitution-Extensions == 2020.9.30.0
+sphinx-sitemap == 2.2.0
 sphinx-togglebutton === 0.3.2
 sphinxcontrib-images === 0.9.4
 myst-parser === 0.18.0

sitemap_index.xml

@@ -0,0 +1,19 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<sitemapindex xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
+   <sitemap>
+      <loc>https://www.min.io/docs/minio/linux/sitemap.xml</loc>
+   </sitemap>
+   <sitemap>
+      <loc>https://www.min.io/docs/minio/windows/sitemap.xml</loc>
+   </sitemap>
+   <sitemap>
+      <loc>https://www.min.io/docs/minio/macos/sitemap.xml</loc>
+   </sitemap>
+   <sitemap>
+      <loc>https://www.min.io/docs/minio/kubernetes/upstream/sitemap.xml</loc>
+   </sitemap>
+   <sitemap>
+      <loc>https://www.min.io/docs/minio/container/sitemap.xml</loc>
+   </sitemap>
+</sitemapindex>

source/_static/css/algolia.css

@@ -0,0 +1,2 @@
+.wy-nav-side { overflow: visible; }
+.wy-side-scroll { overflow: inherit; }

source/_static/js/algolia.js

@@ -0,0 +1,9 @@
+docsearch({
+  apiKey: '0ba0d26da4d1483f96c03fe508304a64',
+  indexName: 'minio',
+  inputSelector: '#algolia input[type=text],
+  debug: false,
+  algoliaOptions: {
+    hitsPerPage: 8,
+  }
+});

source/_templates/searchbox.html

@@ -1,4 +1,5 @@
 {%- if pagename != "search" and builder != "singlehtml" %}
+
 <form class="search" action="{{ pathto('search') }}" method="get" role="search">
    <div class="search__inner">
       <button id="search-close" class="icon visible-rm" type="button">
@@ -8,7 +9,7 @@
          Hide Search
       </button>
 
-      <input type="text" class="search__text" id="docs-search" name="q" aria-labelledby="searchlabel" placeholder="Search Documentation" />
+      <input type="text" class="search__text" id="algolia" name="q" aria-labelledby="searchlabel" placeholder="Search Documentation" />
       
       <kbd class="hidden-rm">
          <span id="search-meta-key"></span>

source/default-conf.py

@@ -34,7 +34,7 @@ copyright = '2020-Present, MinIO, Inc. '
 author = 'MinIO Documentation Team'
 
 # The full version, including alpha/beta/rc tags
-release = '0.1'
+release = '0.2'
 
 
 # -- General configuration ---------------------------------------------------
@@ -50,6 +50,7 @@ extensions = [
     'sphinx-prompt',
     'sphinx_substitution_extensions',
     'sphinx_togglebutton',
+    'sphinx_sitemap',
     'sphinxcontrib.images',
     'myst_parser',
     'sphinx_design',
@@ -83,7 +84,7 @@ extlinks = {
 
 suppress_warnings = [
     'toc.excluded',
-    'myst.ref',
+    'ref.myst',
     'myst.header',
     'myst'
 ]
@@ -100,8 +101,11 @@ templates_path = ['_templates']
 exclude_patterns = ['includes/*', '*-template.rst']
 
 # template for adding custom exclude paths if necessary for a given tag
+# html_baseurl is used by sphinx_sitemap extension to generate a sitemap.xml for each platform.
+# The sitemaps are combined in a sitemapindex.xml file at the root level.
 
 if tags.has("linux"):
+    html_baseurl = 'https://www.min.io/docs/minio/linux/'
     excludes = [
         'operations/install-deploy-manage/deploy-minio-tenant.rst',
         'operations/install-deploy-manage/modify-minio-tenant.rst',
@@ -126,6 +130,7 @@ if tags.has("linux"):
         'reference/kubectl-minio-plugin/kubectl-minio-version.rst',
     ]
 elif tags.has("macos"):
+    html_baseurl = 'https://www.min.io/docs/minio/macos/'
     excludes = [
         'operations/install-deploy-manage/deploy-minio-tenant.rst',
         'operations/install-deploy-manage/modify-minio-tenant.rst',
@@ -150,6 +155,8 @@ elif tags.has("macos"):
         'reference/kubectl-minio-plugin/kubectl-minio-version.rst',
     ]
 elif tags.has("windows"):
+    # html_baseurl is used for generating the sitemap.xml for each platform. These are combined in a sitemapindex.xml.
+    html_baseurl = 'https://www.min.io/docs/minio/windows/'
     excludes = [
         'operations/install-deploy-manage/deploy-minio-tenant.rst',
         'operations/install-deploy-manage/modify-minio-tenant.rst',
@@ -174,6 +181,7 @@ elif tags.has("windows"):
         'reference/kubectl-minio-plugin/kubectl-minio-version.rst',
     ]
 elif tags.has("container"):
+    html_baseurl = 'https://www.min.io/docs/minio/container/'
     excludes = [
         'operations/install-deploy-manage/deploy-minio-tenant.rst',
         'operations/install-deploy-manage/modify-minio-tenant.rst',
@@ -200,6 +208,7 @@ elif tags.has("container"):
         'reference/kubectl-minio-plugin/kubectl-minio-version.rst',
     ]
 elif tags.has("k8s"):
+    html_baseurl = 'https://www.min.io/docs/minio/kubernetes/upstream/'
     excludes = [
         'operations/install-deploy-manage/deploy-minio-single-node-single-drive.rst',
         'operations/install-deploy-manage/deploy-minio-single-node-multi-drive.rst',
@@ -257,6 +266,7 @@ html_css_files = ['css/main.min.css', 'custom.css']
 
 html_js_files = ['js/main.js']
 
+# Add https://www.min.io/robots.txt to html_extra_path list once available.
 html_extra_path = [ 'extra']
 
 html_title = 'MinIO Object Storage for ' + ("MacOS" if platform == "macos" else platform.capitalize())
@@ -274,7 +284,7 @@ sphinx_tabs_disable_css_loading = True
 # k8s is temporary until integrating the references here
 
 intersphinx_mapping = {
-    'baremetal': ('https://docs.min.io/minio/baremetal/', None),
+    'baremetal': ('https://www.min.io/docs/minio/', None),
 }
 
 rst_prolog = """