upgrade site to Antora 3 and leverage latest version segment feature to manage current URL (PR #287)

Author: mojavelinux

Dockerfile.jenkins

@@ -1,13 +1,13 @@
 # This image extends the official Antora image to add bash, ca-certificates, and the aws command. It's used by the CI job.
-FROM antora/antora:2.3.4
+FROM antora/antora:3.0.0-alpha.1
 
 ARG GROUP_ID=1000
 ARG USER_ID=1000
 RUN addgroup -g $GROUP_ID jenkins && \
     adduser -D -u $USER_ID -G jenkins jenkins && \
     apk add --no-cache --quiet bash ca-certificates git openssh-client python && \
-    yarn global add --ignore-optional --silent git+https://gitlab.com/opendevise/oss/antora-site-generator-ms#v2.3.4 && \
-    yarn global add --ignore-optional --silent git+https://gitlab.com/antora/xref-validator#v1.0.0-alpha.12 && \
+    yarn global add --ignore-optional --silent git+https://gitlab.com/opendevise/oss/antora-site-generator-ms#v3.0.0-alpha.1 && \
+    yarn global add --ignore-optional --silent git+https://gitlab.com/antora/xref-validator#v1.0.0-alpha.13 && \
     apk add --no-cache --quiet --virtual .build-deps py2-pip && \
     pip install --no-cache-dir --quiet --disable-pip-version-check awscli && \
     apk del --no-cache --quiet --purge .build-deps

Jenkinsfile

@@ -51,7 +51,6 @@ pipeline {
     OPTANON_SCRIPT_DATA_DOMAIN_SCRIPT = "748511ff-10bf-44bf-88b8-36382e5b5fd9"
     NODE_PATH='/usr/local/share/.config/yarn/global/node_modules'
     SHOW_FEEDBACK_BUTTON='true'
-    SUPPORTS_CURRENT_URL='true'
   }
   triggers {
     githubPush()

antora-playbook.yml

@@ -8,6 +8,9 @@ site:
     google_analytics: GTM-MVPNN2
 git:
   ensure_git_suffix: false
+urls:
+  latest_version_segment: current
+  latest_version_segment_strategy: redirect:to
 content:
   branches: master
   # NOTE the git@ segment in the URL indicates which repositories are private
@@ -116,6 +119,6 @@ asciidoc:
   - ./lib/tabs-block.js
 ui:
   bundle:
-    url: https://github.com/couchbase/docs-ui-sandbox/releases/download/prod-82/ui-bundle.zip
+    url: https://github.com/couchbase/docs-ui-sandbox/releases/download/prod-83/ui-bundle.zip
 output:
   dir: ./public

etc/nginx/snippets/rewrites.conf

@@ -27,23 +27,8 @@ set $current_version_sdk_ruby_api '3.0.0';
 set $current_version_sdk_scala '1.0';
 set $current_version_sdk_scala_api '1.0.8';
 set $current_version_txns_java_api '1.1.0';
-
-# current URL cloaks
-location ^~ /server/current/ { rewrite ^/(server)/current/(.*)$ /$1/$current_version_server/$2 last; }
-location ^~ /operator/current/ { rewrite ^/(operator)/current/(.*)$ /$1/$current_version_operator/$2 last; }
-location ^~ /couchbase-lite/current/ { rewrite ^/(couchbase-lite)/current/(.*)$ /$1/$current_version_couchbase_lite/$2 last; }
-location ^~ /sync-gateway/current/ { rewrite ^/(sync-gateway)/current/(.*)$ /$1/$current_version_sync_gateway/$2 last; }
-location ^~ /c-sdk/current/ { rewrite ^/(c-sdk)/current/(.*)$ /$1/$current_version_sdk_c/$2 last; }
-location ^~ /dotnet-sdk/current/ { rewrite ^/(dotnet-sdk)/current/(.*)$ /$1/$current_version_sdk_dotnet/$2 last; }
-location ^~ /go-sdk/current/ { rewrite ^/(go-sdk)/current/(.*)$ /$1/$current_version_sdk_go/$2 last; }
-location ^~ /java-sdk/current/ { rewrite ^/(java-sdk)/current/(.*)$ /$1/$current_version_sdk_java/$2 last; }
-location ^~ /nodejs-sdk/current/ { rewrite ^/(nodejs-sdk)/current/(.*)$ /$1/$current_version_sdk_nodejs/$2 last; }
-location ^~ /php-sdk/current/ { rewrite ^/(php-sdk)/current/(.*)$ /$1/$current_version_sdk_php/$2 last; }
-location ^~ /python-sdk/current/ { rewrite ^/(python-sdk)/current/(.*)$ /$1/$current_version_sdk_python/$2 last; }
-location ^~ /scala-sdk/current/ { rewrite ^/(scala-sdk)/current/(.*)$ /$1/$current_version_sdk_scala/$2 last; }
-location ^~ /elasticsearch-connector/current/ { rewrite ^/(elasticsearch-connector)/current/(.*)$ /$1/$current_version_connector_elasticsearch/$2 last; }
-location ^~ /kafka-connector/current/ { rewrite ^/(kafka-connector)/current/(.*)$ /$1/$current_version_connector_kafka/$2 last; }
-location ^~ /spark-connector/current/ { rewrite ^/(spark-connector)/current/(.*)$ /$1/$current_version_connector_spark/$2 last; }
+# current URL cloaks are now handled by Antora
+# -
 # archived version redirects (must use longest prefix since nginx executes regexp locations out of order)
 location ^~ /server/4.0/ { rewrite ^/([^/]+)/[^/]+/(.*)$ /$1/current/$2 redirect; }
 location ^~ /server/4.1/ { rewrite ^/([^/]+)/[^/]+/(.*)$ /$1/current/$2 redirect; }

lib/inline-man-macro.js

@@ -19,11 +19,11 @@
  */
 const { posix: path } = require('path')
 
-function initInlineManMacro (context) {
+function initInlineManMacro ({ file }) {
   return function () {
     this.process((parent, target, attrs) => {
       const text = target.startsWith('couchbase-cli-') ? target.substr(14) : target
-      const refid = path.join(path.dirname(context.file.src.relative), target)
+      const refid = path.join(path.dirname(file.src.relative), target)
       const attributes = Opal.hash2(['refid', 'path'], { refid, path: refid + '.adoc' })
       return this.createInline(parent, 'anchor', text, { type: 'xref', target: refid + '.adoc', attributes })
     })

lib/json-config-ui-block-macro.js

@@ -19,10 +19,8 @@ function blockJsonConfigUiMacro ({ file }) {
         configUrl = doc.$sub_attributes(configUrl, Opal.hash({ attribute_missing: 'drop-line' }))
         if (!configUrl) return
       }
-      const version = attrs.$$is_hash ? Opal.hash_get(attrs, 'version') : attrs.version
-      const contentScripts = buildJsonConfigUi({ configUrl, version, bundleBaseUrl: BUNDLE_BASE_URL })
-      if ((file.asciidoc || {}).attributes) file.asciidoc.attributes['page-content-scripts'] = contentScripts
-      Opal.hash_put(doc.header_attributes, 'page-content-scripts', contentScripts) // Antora 2.2
+      const contentScripts = buildJsonConfigUi({ configUrl, version: attrs.version, bundleBaseUrl: BUNDLE_BASE_URL })
+      file.asciidoc.attributes['page-content-scripts'] = contentScripts
       return this.createBlock(parent, 'pass', '<div id="swagger-ui"></div>')
     })
   }

lib/multirow-table-head-tree-processor.js

@@ -1,6 +1,6 @@
 function multirowTableHeadTreeProcessor () {
   this.process((doc) => {
-    for (let table of doc.findBy({ context: 'table' })) {
+    for (const table of doc.findBy({ context: 'table' })) {
       const hrows = table.getAttribute('hrows')
       if (hrows) {
         const rows = table.rows
@@ -11,8 +11,8 @@ function multirowTableHeadTreeProcessor () {
   })
 }
 
-function register (registry, context) {
-  if (context.file.contents.includes('hrows=')) {
+function register (registry, { file }) {
+  if (file.contents.includes('hrows=')) {
     registry.treeProcessor(multirowTableHeadTreeProcessor)
   }
 }

lib/source-url-include-processor.js

@@ -23,6 +23,7 @@ function initSourceUrlIncludeProcessor ({ file, contentCatalog }) {
       const includeFileSrc = includeFile.context
       let sourceUrl = includeFileSrc.editUrl.replace(`/edit/${includeFileSrc.origin.branch}`, `/blob/${includeFileSrc.origin.refhash}`) + resolveLineRangeFragment(includeFile.contents, attrs)
       reader.pushInclude(`[data-source-url=${sourceUrl}]\n`, target, target, 1, attrs)
+      // NOTE: this assignment works since the attribute is only used internally by this extension
       Opal.hash_put(doc.header_attributes, 'promote-data-source-url', '')
     })
   }

lib/swagger-ui-block-macro.js

@@ -65,8 +65,7 @@ function blockSwaggerUiMacro ({ file }) {
         ? 'https://cb-docs-swagger.s3.amazonaws.com/dist3'
         : 'https://couchbase-docs.s3.amazonaws.com/assets/swagger-ui-3.7'
       const contentScripts = buildSwaggerUi({ specUrl, bundleUrl })
-      if ((file.asciidoc || {}).attributes) file.asciidoc.attributes['page-content-scripts'] = contentScripts
-      Opal.hash_put(doc.header_attributes, 'page-content-scripts', contentScripts) // Antora 2.2
+      file.asciidoc.attributes['page-content-scripts'] = contentScripts
       return this.createBlock(parent, 'pass', '<div id="swagger-ui"></div>')
     })
   }

lib/tabs-block.js

@@ -73,7 +73,7 @@ function tabsBlock () {
   })
 }
 
-function register (registry, context) {
+function register (registry) {
   registry.block('tabs', tabsBlock)
 }
 

netlify/netlify.toml

@@ -4,10 +4,10 @@ ignore = "false"
 
 [build.environment]
 CI = "true"
-NODE_VERSION = "12"
+NODE_VERSION = "10"
+NODE_OPTIONS = "--max-old-space-size=4096"
 NPM_FLAGS = "--no-optional"
 ANTORA_CACHE_DIR = "node_modules/.cache/antora"
-SUPPORTS_CURRENT_URL="true"
 
 # NOTE branch-deploy refers to the master branch
 
@@ -22,9 +22,8 @@ command = """\
 if [ -v FONTAWESOME_NPM_TOKEN ]; then echo -e '@fortawesome:registry=https://npm.fontawesome.com/\\n//npm.fontawesome.com/:_authToken=$''{FONTAWESOME_NPM_TOKEN}\\n' > ../scripts/.npmrc; fi; \
 (cd ../scripts; npm --no-package-lock i || true) && \
 if [ -v GITHUB_TOKEN ]; then export GIT_CREDENTIALS=https://$GITHUB_TOKEN:@github.com; else node ../scripts/remove-private-content-sources.js ../antora-playbook.yml; fi; \
-node_modules/.bin/antora --fetch --generator=@antora/xref-validator ../antora-playbook.yml || true; \
-node_modules/.bin/antora --redirect-facility=netlify --to-dir=public --url $DEPLOY_PRIME_URL ../antora-playbook.yml && \
-node ../scripts/add-current-url-redirects.js ../etc/nginx/snippets/rewrites.conf && \
+time node_modules/.bin/antora --fetch --generator=@antora/xref-validator ../antora-playbook.yml || true; \
+time node_modules/.bin/antora --redirect-facility=netlify --to-dir=public --url $DEPLOY_PRIME_URL ../antora-playbook.yml && \
 node ../scripts/populate-icon-defs.js public\
 """