Refactor and cleanup

Author: reakaleek

extra/client_docs_landing.html

@@ -51,8 +51,6 @@
   }
   </style>
 
-  <link rel="canonical" href="https://www.elastic.co/guide/en/elasticsearch/client/index.html"/>
-
   <div class="legalnotice"></div>
 
   <div class="row my-4">
@@ -181,4 +179,4 @@ <h4 class="mt-3">
   </div>
 
   <p class="my-4"><a href="https://www.elastic.co/guide/index.html">View all Elastic docs</a></p>
-  <p class="my-4"><small>The Ruby logo available <a href="https://www.ruby-lang.org/en/about/logo/">here</a> is released under the Creative Commons <a href="https://creativecommons.org/licenses/by-sa/2.5/"> Attribution-Share Alike 2.5 License</a>. The Go gopher created by Renee French available <a href="https://go.dev/blog/gopher">here</a> and the PHP logo available <a href="https://www.php.net/download-logos.php">here</a> are released under the Creative Commons <a href="https://creativecommons.org/licenses/by-sa/4.0/deed.en"> Attribution-Share Alike 4.0 International license</a>. </small></p>
+  <p class="my-4"><small>The Ruby logo available <a href="https://www.ruby-lang.org/en/about/logo/">here</a> is released under the Creative Commons <a href="https://creativecommons.org/licenses/by-sa/2.5/"> Attribution-Share Alike 2.5 License</a>. The Go gopher created by Renee French available <a href="https://go.dev/blog/gopher">here</a> and the PHP logo available <a href="https://www.php.net/download-logos.php">here</a> are released under the Creative Commons <a href="https://creativecommons.org/licenses/by-sa/4.0/deed.en"> Attribution-Share Alike 4.0 International license</a>. </small></p>

preview/preview.js

@@ -82,7 +82,7 @@ const requestHandler = async (core, parsedUrl, response) => {
     const lang = await file.lang();
     const initialJsState = await buildInitialJsState(file.alternativesReport);
     const templated = template.apply(
-      file.stream[Symbol.asyncIterator](), lang.trim(), initialJsState, path,
+      file.stream[Symbol.asyncIterator](), lang.trim(), initialJsState
     );
     return new Promise((resolve, reject) => {
       file.stream.on("error", reject);

resources/asciidoctor/lib/chunker/url_to_v3.rb

@@ -7,18 +7,11 @@ class UrlToV3
     def initialize(doc)
       current_url = doc.attr('current-url')
       outdir = doc.attr('outdir')
-
       current_url ||= 'index.html'
-      
-      # raise ArgumentError, "Missing required attribute 'current-url'" if current_url.nil?
-      # raise ArgumentError, "Missing required attribute 'outdir'" if outdir.nil?
-
-      # Hardcoded file path
       file_path = File.expand_path('v3-mapping.json', __dir__)
-      # Read content from the specified file and convert it to a dictionary
       mapping = JSON.parse(File.read(file_path)) if File.exist?(file_path)
-
-      segments = outdir.sub('/tmp/docsbuild/target_repo/raw', '').split('/')
+      segments = outdir.sub('/tmp/docsbuild/target_repo/raw', '').split('/') # This only works in CI. 
+      version = segments[-1] || 'unknown'
 
       path_dir = if segments.empty?
         ''
@@ -29,18 +22,25 @@ def initialize(doc)
       end
 
       actual_url = path_dir + '/*/' + current_url
-
-      if mapping.key?(actual_url)
-        new_url = mapping[actual_url]
+      new_url = if mapping.key?(actual_url)
+        mapping[actual_url]
       else
-       new_url = '/docs'
+        '/docs'
       end
 
-      @url = Asciidoctor::Block.new(doc, :pass, source: <<~HTML)
-      <div id="url-to-v3" style="display: none;">
-        A newer version is available. For the latest information, see the <a href="https://www.elastic.co#{new_url}">current release documentation</a>
-      </div>
-      HTML
+      if version == '8.18'
+        @url = Asciidoctor::Block.new(doc, :pass, source: <<~HTML)
+          <div id="url-to-v3" style="version-warning">
+            A newer version is available. For the latest information, see the <a href="https://www.elastic.co#{new_url}">current release documentation</a>
+          </div>
+        HTML
+      else
+        @url = Asciidoctor::Block.new(doc, :pass, source: <<~HTML)
+          <div id="url-to-v3" class="version-warning">
+            <bold>IMPORTANT</bold>: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the <a href="https://www.elastic.co#{new_url}">current release documentation</a>
+          </div>
+        HTML
+      end
     end
   end
 end

resources/web/air_gapped_template.html

@@ -60,9 +60,6 @@
                 <div class="col-12 order-2 col-md-4 order-md-1 col-lg-3 h-almost-full-md sticky-top-md" id="left_col">
                   <!-- The TOC is appended here -->
                 </div>
-                <div id="what-the-what">
-                <!-- DOCS CURRENT -->
-                </div>
 
                 <div class="col-12 order-1 col-md-8 order-md-2 col-lg-7 order-lg-2 guide-section" id="middle_col">
                   <!-- start body -->

resources/web/style/page_header.pcss

@@ -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/web/template.html

@@ -73,9 +73,6 @@
     <script src='https://www.elastic.co/elastic-nav.js'></script>
 
     <div class="main-container">
-      <div>
-        <!-- DOCS CURRENT -->
-      </div>
       <section id="content" >
         <div class="content-wrapper">
 
@@ -85,6 +82,7 @@
                 <div class="col-12 order-2 col-md-4 order-md-1 col-lg-3 h-almost-full-md sticky-top-md" id="left_col">
                   <!-- The TOC is appended here -->
                 </div>
+
                 <div class="col-12 order-1 col-md-8 order-md-2 col-lg-7 order-lg-2 guide-section" id="middle_col">
                   <!-- start body -->
                   <!-- DOCS BODY -->
@@ -146,13 +144,6 @@
 
     <script src="/guide/static/jquery.js"></script>
     <script type="text/javascript" src="/guide/static/docs-v1.js"></script>
-    <script>
-      var pageHeader = document.querySelector('.page_header');
-      var urlToV3 = document.querySelector('#url-to-v3');
-      if (pageHeader && urlToV3) {
-        pageHeader.innerHTML = urlToV3.innerHTML;
-      }
-    </script>
     <!-- DOCS FINAL -->
   </body>
 </html>

template/template.js

@@ -32,7 +32,7 @@ const readFile = promisify(fs.readFile);
 const stat = promisify(fs.stat);
 
 module.exports = templateSource => {
-  const apply = (rawItr, lang, initialJsState, destPath) => {
+  const apply = (rawItr, lang, initialJsState) => {
     /*
      * We apply the template by walking a stream for the template and a stream
      * for the raw page in parallel. We do this instead of pulling everything
@@ -185,9 +185,10 @@ module.exports = templateSource => {
       const raw = fs.createReadStream(source, {encoding: 'UTF-8'});
       const write = fs.createWriteStream(dest, {encoding: 'UTF-8'});
       await new Promise((resolve, reject) => {
-        const out = apply(raw[Symbol.asyncIterator](), lang, initialJsState, dest);
+        const out = apply(raw[Symbol.asyncIterator](), lang, initialJsState);
         write.on("close", resolve);
         write.on("error", reject);
+        // out.on("error", write.destroy) doesn't properly forward the error!
         out.on("error", err => write.destroy(err));
         out.pipe(write);
       }).finally(() => raw.close());