Add version mapping and bump to 8.18 (#3198)

* inject test

* try again

* test

* test again

* test

* test

* ok

* commit am speed up

* Revert conf

* ok

* Try without file read

* test

* fix

* test

* fix

* test

* ok

* Remove /guide prefix

* Refactor and cleanup

* Revert nav.rb

* Update v3-mapping.json (not finalized yet)

* Refactor to satisfy rubocop

* bumping current docs to 8.18

* Update stacklive

* remove 404ing redirects

* Fix styling

* update with FINAL redirects

* fix 404

* Adjust wording

* Add old elastic docs experience warning

* Remove 404ing beats links

* css updates for landing page and text update

* Fix z-index

* Increase font-weight for h2 and h3 tags

* update landing page to point to 8.18, etc.

* fix

* Move heading

* Update documentation links to version 8.18

* one row

---------

Co-authored-by: Brandon Morelli <[email protected]>
Co-authored-by: Edu González de la Herrán <[email protected]>
Co-authored-by: Colleen McGinnis <[email protected]>

Author: 4 people

conf.yaml

@@ -80,8 +80,8 @@ contents_title:     Elastic documentation
 #   <key>: &<variable> <value>
 # The keys don't really matter, but by convention the are the same as the variable.
 variables:
-  stackcurrent: &stackcurrent 8.17
-  stacklive: &stacklive [ 8.17, 7.17 ]
+  stackcurrent: &stackcurrent 8.18
+  stacklive: &stacklive [ 8.18 ]
 
   cloudSaasCurrent: &cloudSaasCurrent ms-122
 
@@ -2289,7 +2289,7 @@ contents:
               -
                 repo:   docs
                 path:   shared/versions/stack/current.asciidoc
-    -   title:      Legacy Documentation
+    -   title:      Archive
         sections:
           - title:      Elastic Stack and Google Cloud's Anthos
             noindex:    1

extra/docs_landing.html

@@ -9,6 +9,7 @@
 require_relative 'find_related'
 require_relative 'footnotes'
 require_relative 'nav'
+require_relative 'url_to_v3'
 
 ##
 # HTML5 converter that chunks like docbook.
@@ -49,6 +50,7 @@ def convert_document(doc)
       )
       doc.attributes['next_section'] = find_next_in doc, 0
       add_nav doc
+      add_url_to_v3 doc
       yield
     end
 
@@ -81,6 +83,11 @@ def add_nav(doc)
       doc.blocks.append nav.footer
     end
 
+    def add_url_to_v3(doc)
+      url_to_v3 = UrlToV3.new doc
+      doc.blocks.insert 0, url_to_v3.url
+    end
+
     def correct_xref(node)
       refid = node.attributes['refid']
       return unless (ref = node.document.catalog[:refs][refid])
@@ -108,6 +115,8 @@ def form_section_into_page(doc, section, html)
 
     def add_subdoc_sections(doc, subdoc, html)
       nav = Nav.new subdoc
+      url_to_v3 = UrlToV3.new subdoc
+      subdoc << url_to_v3.url
       subdoc << nav.header
       subdoc << Asciidoctor::Block.new(subdoc, :pass, source: html)
       subdoc << footnotes(doc, subdoc) if doc.footnotes?
@@ -143,6 +152,7 @@ def subdoc_attrs(doc, section)
       attrs['subdoc'] = true # Mark the subdoc so we don't try and chunk it
       attrs['title-separator'] = ''
       attrs['canonical-url'] = section.attributes['canonical-url']
+      attrs['current-url'] = "#{section.id}.html"
       attrs.merge! find_related(section)
       attrs
     end

resources/asciidoctor/lib/chunker/extension.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module Chunker
+  # Add a warning to the page with a link to docs v3
+  class UrlToV3
+    attr_reader :url
+
+    def initialize(doc)
+      current_url = doc.attr('current-url')
+      outdir = doc.attr('outdir')
+      current_url ||= 'index.html'
+      m = mapping
+      # This only works in CI.
+      segments = outdir.sub('/tmp/docsbuild/target_repo/raw', '').split('/')
+      version = segments[-1] || 'unknown'
+      actual_url = get_actual_url(outdir, current_url)
+      new_url = if m.key?(actual_url)
+                  m[actual_url]
+                else
+                  '/docs'
+                end
+      render_warning(doc, version, new_url)
+    end
+
+    def mapping
+      file_path = File.expand_path('v3-mapping.json', __dir__)
+      JSON.parse(File.read(file_path)) if File.exist?(file_path)
+    end
+
+    def get_path_dir(outdir)
+      segments = outdir.sub('/tmp/docsbuild/target_repo/raw', '').split('/')
+      if segments.empty?
+        ''
+      elsif segments.length > 1
+        segments[0...-1].join('/')
+      else
+        segments[0]
+      end
+    end
+
+    def get_actual_url(outdir, current_url)
+      get_path_dir(outdir) + '/*/' + current_url
+    end
+
+    def render_warning(doc, version, new_url)
+      if version == '8.18'
+        @url = Asciidoctor::Block.new(doc, :pass, source: <<~HTML)
+          <div id="url-to-v3" class="version-warning">
+              A newer version is available. Check out the <a href="https://www.elastic.co#{new_url}">latest documentation</a>.
+          </div>
+        HTML
+      else
+        @url = Asciidoctor::Block.new(doc, :pass, source: <<~HTML)
+          <div id="url-to-v3" class="version-warning">
+              <strong>IMPORTANT</strong>: This documentation is no longer updated. Refer to <a href="https://www.elastic.co/support/eol">Elastic's version policy</a> and the <a href="https://www.elastic.co#{new_url}">latest documentation</a>.
+          </div>
+        HTML
+      end
+    end
+  end
+end

resources/asciidoctor/lib/chunker/url_to_v3.rb

@@ -5,9 +5,19 @@
     border: 1px solid #ccc;
     background: #FFFFD2;
     color: black;
+    display: none;
   }
 
-  .abstract .page_header {
+  .version-warning {
+    padding: 1em;
+    margin-bottom: 1em;
+    border: 1px solid #ccc;
+    background: #FFFFD2;
+    color: black;
+  }
+
+  .abstract .page_header,
+  .abstract .version-warning {
       width: 100%;
   }
 }

resources/asciidoctor/lib/chunker/v3-mapping.json

@@ -29,7 +29,7 @@ release-state can be: released | prerelease | unreleased
 //////////
 is-current-version can be: true | false
 //////////
-:is-current-version:    true
+:is-current-version:    false
 
 //////////
 hide-xpack-tags defaults to "false" (they are shown unless set to "true")

resources/web/style/page_header.pcss

@@ -1 +1 @@
-include::8.17.asciidoc[]
+include::8.18.asciidoc[]