solalraveh · solalraveh · Sep 23, 2020 · Jul 1, 2020 · Jul 1, 2020 · Jul 5, 2020
diff --git a/_build/rn_details.py b/_build/rn_details.py
@@ -0,0 +1,152 @@
+import argparse
+import pathlib
+import re
+import shutil
+import string
+import sys
+import tempfile
+import yaml
+
+template = string.Template("""
+[cols="1,4"]
+|===
+|Download link
+|$Link
+
+|Type
+|$Type
+
+|Build
+|$Build
+
+|Date
+|$Date
+
+|SHA256 Digest
+|$Digest
+|===
+""")
+
+# Record that holds all command line params.
+#  topic_map_path   - Path to topic map.
+#  topic_map_yaml   - Topic map YAML.
+#  input_dir        - Path to top of output dir.
+#  release_info     - Path to release info
+class Config:
+  pass
+
+
+def parse_doc_tree(config):
+  """
+  Constructs a directory that holds all converted files, graphics, and the topic_map.
+  """
+  # Fix up each ADOC file in the topic map.
+  print('Populating release notes info')
+  for chapter in config.topic_map_yaml:
+    directory = pathlib.Path(config.input_dir) / pathlib.Path(chapter['Dir'])
+    walk_segment(config, chapter, directory)
+
+
+def walk_segment(config, segment, directory, depth=1):
+
+  for article in segment['Topics']:
+    if 'Topics' in article:
+      nested_dir = pathlib.Path(directory) / pathlib.Path(article['Dir'])
+      walk_segment(config, article, nested_dir, depth+1)
+    else:
+      src_file = pathlib.Path(directory).joinpath(article['File'])
+      src_file = src_file.with_suffix('.adoc')
+      populate_release_info(config, src_file)
+
+
+def populate_release_info(config, src_file):
+
+  global template
+
+  for release in config.release_info_yaml:
+    if release['File'] == str(pathlib.PurePath(src_file).name):
+      sed_inplace(src_file, r'^// STATIC_SITE_RELEASE_PARTICULARS', template.substitute(release))
+
+
+def sed_inplace(filename, pattern, repl):
+  '''
+  Perform the pure-Python equivalent of in-place `sed` substitution: e.g.,
+  `sed -i -e 's/'${pattern}'/'${repl}' "${filename}"`.
+
+  See: https://stackoverflow.com/questions/4427542/how-to-do-sed-like-text-replace-with-python
+  '''
+  # For efficiency, precompile the passed regular expression.
+  pattern_compiled = re.compile(pattern)
+
+  # For portability, NamedTemporaryFile() defaults to mode "w+b" (i.e., binary
+  # writing with updating). This is usually a good thing. In this case,
+  # however, binary writing imposes non-trivial encoding constraints trivially
+  # resolved by switching to text writing. Let's do that.
+  with tempfile.NamedTemporaryFile(mode='w', delete=False) as tmp_file:
+    with filename.open() as f:
+      for line in f:
+        tmp_file.write(pattern_compiled.sub(repl, line))
+
+  # Overwrite the original file with the munged temporary file in a
+  # manner preserving file attributes (e.g., permissions).
+  shutil.copystat(filename, tmp_file.name)
+  shutil.move(tmp_file.name, filename)
+
+
+def validate_file_path(file_path):
+  """
+  Validate the input path is a directory that contains a _topic_map.yml file.
+  """
+  path = pathlib.Path(file_path)
+
+  # Check if file exists in the file system at the specified path
+  if path.exists():
+    return True
+  else:
+    print(f'Cannot find {file_path}')
+    sys.exit(1)
+
+
+def main():
+  """
+  """
+  parser = argparse.ArgumentParser(description='Populate release particulars (i.e CDN download link) in the release notes.')
+  parser.add_argument('topic_map', type=str, help='Path to _topic_map.yml')
+  parser.add_argument('release_info', type=str, help='Path to release_info.yml')
+  args = parser.parse_args()
+
+  # FIX: The Config class should have methods to parse and save config options.
+  config = Config()
+
+  if validate_file_path(args.topic_map):
+    config.topic_map_path = pathlib.Path(args.topic_map)
+  config.input_dir = config.topic_map_path.parent
+
+  # Open and read the topic map. If the file cannot be parsed,
+  # exit the program and return 1.
+  with config.topic_map_path.open(mode='r') as stream:
+    try:
+      config.topic_map_yaml = list(yaml.full_load_all(stream))
+    except yaml.YAMLError as e:
+      print(f'Error: Invalid YAML in _topic_map.yml: {e}')
+      sys.exit(1)
+
+  if validate_file_path(args.release_info):
+    config.release_info_path = pathlib.Path(args.release_info)
+
+  # Open and read the topic map. If the file cannot be parsed,
+  # exit the program and return 1.
+  with config.release_info_path.open(mode='r') as stream:
+    try:
+      config.release_info_yaml = yaml.full_load(stream)
+    except yaml.YAMLError as e:
+      print(f'Error: Invalid YAML in _topic_map.yml: {e}')
+      sys.exit(1)
+
+  parse_doc_tree(config)
+
+  print('OK')
+
+
+if __name__ == '__main__':
+  main()
diff --git a/_files/_distro_map.yml b/_files/_distro_map.yml
@@ -7,7 +7,7 @@ compute_edition:
   site_url: https://docs.twistlock.com/docs/
   branches:
     master:
-      name: 'Compute Edition 20.04 (Self-Hosted)'
+      name: 'Compute Edition 20.09 (Self-Hosted)'
       dir: 'compute_edition'
     ref_arch:
       name: 'Reference Architecture'
@@ -24,6 +24,9 @@ compute_edition:
     historical:
       name: 'Historical documentation'
       dir: 'historical'
+    saas_upgrades:
+      name: 'SaaS upgrade announcements'
+      dir: 'saas_upgrades'
 prisma_cloud:
   name: Prisma Cloud Enterprise Edition
   author: Prisma Cloud community

diff --git a/_files/_templates/_topnav.html.erb b/_files/_templates/_topnav.html.erb
@@ -25,12 +25,14 @@
                 <!-- Dropdown list -->
                     <div class="dropdown-menu dropdown-menu-right">
                       <ul class="header-main-subnav">
-                        <li><a class="dropdown-item" href="../../compute_edition/welcome/welcome.html">Compute Edition 20.04 (Self-Hosted)</a></li>
+                        <li><a class="dropdown-item" href="../../compute_edition/welcome/welcome.html">Compute Edition 20.09 (Self-Hosted)</a></li>
                         <li><a class="dropdown-item" href="../../enterprise_edition/welcome/welcome.html">Enterprise Edition (SaaS)</a></li>
                         <li><a class="dropdown-item" href="../../ref_arch/objectives/objectives.html">Reference Architecture</a></li>
                         <li><a class="dropdown-item" href="../../ops_guide/getting_started/getting_started.html">Operationalize Guide</a></li>
                         <li><a class="dropdown-item" href="../../troubleshooting/troubleshooting/collect_debug_data.html">Troubleshooting</a></li>
+                        <li><a class="dropdown-item" href="https://cdn.twistlock.com/docs/attachments/performance_planning.pdf">Performance Planning</a></li>
                         <li><a class="dropdown-item" href="../../historical/historical/historical.html">Historical Documentation</a></li>
+                        <li><a class="dropdown-item" href="../../saas_upgrades/announcements/announcements.html">SaaS Upgrade Announcements</a></li>
                       </ul>
                     </div>
                 </li>

diff --git a/_files/index-main.html b/_files/index-main.html
@@ -123,12 +123,14 @@
                     	<!-- Dropdown list -->
                         <div class="dropdown-menu dropdown-menu-right">
                           <ul class="header-main-subnav">
-                            <li><a class="dropdown-item" href="compute_edition/welcome/welcome.html">Compute Edition 20.04 (Self-Hosted)</a></li>
+                            <li><a class="dropdown-item" href="compute_edition/welcome/welcome.html">Compute Edition 20.09 (Self-Hosted)</a></li>
                             <li><a class="dropdown-item" href="enterprise_edition/welcome/welcome.html">Enterprise Edition (SaaS)</a></li>
                             <li><a class="dropdown-item" href="ref_arch/objectives/objectives.html">Reference Architecture</a></li>
                             <li><a class="dropdown-item" href="ops_guide/getting_started/getting_started.html">Operationalize Guide</a></li>
                             <li><a class="dropdown-item" href="troubleshooting/troubleshooting/collect_debug_data.html">Troubleshooting</a></li>
+                            <li><a class="dropdown-item" href="https://cdn.twistlock.com/docs/attachments/performance_planning.pdf">Performance Planning</a></li>
                             <li><a class="dropdown-item" href="historical/historical/historical.html">Historical Documentation</a></li>
+                            <li><a class="dropdown-item" href="saas_upgrades/announcements/announcements.html">SaaS Upgrade Announcements</a></li>
                           </ul>
                         </div>
                     </li>