Merge pull request #285 from dcolebatch/1-improve-look-and-feel-of-documentation

improve look and feel of documentation

Author: dcolebatch

Dockerfile

@@ -1,4 +1,4 @@
-FROM ruby:2.1
+FROM ruby:3.3.4
 MAINTAINER mrafayaleem@gmail.com
 
 RUN apt-get clean \
@@ -8,18 +8,21 @@ RUN apt-get clean \
 RUN apt-get update
 
 RUN apt-get install -y \
-    node \
-    python-pygments \
+    nodejs \
+    python3-pygments \
+    build-essential \
+    libxml2-dev \
+    libxslt-dev \
   && apt-get clean \
   && rm -rf /var/lib/apt/lists/
 
 WORKDIR /tmp
 ADD Gemfile /tmp/
 ADD Gemfile.lock /tmp/
-RUN bundle install
+RUN gem install bundler && bundle install
 
 VOLUME /src
 EXPOSE 4000
 
 WORKDIR /src
-ENTRYPOINT ["jekyll", "serve", "-H", "0.0.0.0"]
+ENTRYPOINT ["bundle", "exec", "jekyll", "serve", "-H", "0.0.0.0"]

Gemfile

@@ -1,8 +1,17 @@
 source "https://rubygems.org"
 
+# Pinning problematic gems to compatible versions
+gem "commonmarker", "~> 0.23.8"
+gem "unf_ext", "~> 0.0.7.7"
+gem "eventmachine", "~> 1.2.5"
+gem "http_parser.rb", "~> 0.6.0"
+gem "racc", "~> 1.5.2"
+
 group :jekyll_plugins do
-  gem 'github-pages'
+  gem 'github-pages', '~> 232'
   gem 'jekyll-feed'
   gem 'jekyll-redirect-from'
   gem 'jekyll-sitemap'
 end
+
+

Gemfile.lock

@@ -11,10 +11,11 @@ GEM
     coffee-script (2.4.1)
       coffee-script-source
       execjs
-    coffee-script-source (1.11.1)
+    coffee-script-source (1.12.2)
     colorator (1.1.0)
     commonmarker (0.23.10)
     concurrent-ruby (1.2.2)
+    csv (3.3.4)
     dnsruby (1.61.9)
       simpleidn (~> 0.1)
     em-websocket (0.5.3)
@@ -31,16 +32,16 @@ GEM
     ffi (1.15.5)
     forwardable-extended (2.6.0)
     gemoji (3.0.1)
-    github-pages (228)
-      github-pages-health-check (= 1.17.9)
-      jekyll (= 3.9.3)
-      jekyll-avatar (= 0.7.0)
-      jekyll-coffeescript (= 1.1.1)
-      jekyll-commonmark-ghpages (= 0.4.0)
-      jekyll-default-layout (= 0.1.4)
-      jekyll-feed (= 0.15.1)
+    github-pages (232)
+      github-pages-health-check (= 1.18.2)
+      jekyll (= 3.10.0)
+      jekyll-avatar (= 0.8.0)
+      jekyll-coffeescript (= 1.2.2)
+      jekyll-commonmark-ghpages (= 0.5.1)
+      jekyll-default-layout (= 0.1.5)
+      jekyll-feed (= 0.17.0)
       jekyll-gist (= 1.5.0)
-      jekyll-github-metadata (= 2.13.0)
+      jekyll-github-metadata (= 2.16.1)
       jekyll-include-cache (= 0.2.1)
       jekyll-mentions (= 1.6.0)
       jekyll-optional-front-matter (= 0.3.2)
@@ -67,30 +68,32 @@ GEM
       jekyll-theme-tactile (= 0.2.0)
       jekyll-theme-time-machine (= 0.2.0)
       jekyll-titles-from-headings (= 0.5.3)
-      jemoji (= 0.12.0)
-      kramdown (= 2.3.2)
+      jemoji (= 0.13.0)
+      kramdown (= 2.4.0)
       kramdown-parser-gfm (= 1.1.0)
       liquid (= 4.0.4)
       mercenary (~> 0.3)
       minima (= 2.5.1)
-      nokogiri (>= 1.13.6, < 2.0)
-      rouge (= 3.26.0)
+      nokogiri (>= 1.16.2, < 2.0)
+      rouge (= 3.30.0)
       terminal-table (~> 1.4)
-    github-pages-health-check (1.17.9)
+      webrick (~> 1.8)
+    github-pages-health-check (1.18.2)
       addressable (~> 2.3)
       dnsruby (~> 1.60)
-      octokit (~> 4.0)
-      public_suffix (>= 3.0, < 5.0)
+      octokit (>= 4, < 8)
+      public_suffix (>= 3.0, < 6.0)
       typhoeus (~> 1.3)
     html-pipeline (2.14.3)
       activesupport (>= 2)
       nokogiri (>= 1.4)
-    http_parser.rb (0.8.0)
+    http_parser.rb (0.6.0)
     i18n (1.14.1)
       concurrent-ruby (~> 1.0)
-    jekyll (3.9.3)
+    jekyll (3.10.0)
       addressable (~> 2.4)
       colorator (~> 1.0)
+      csv (~> 3.0)
       em-websocket (~> 0.5)
       i18n (>= 0.7, < 2)
       jekyll-sass-converter (~> 1.0)
@@ -101,27 +104,28 @@ GEM
       pathutil (~> 0.9)
       rouge (>= 1.7, < 4)
       safe_yaml (~> 1.0)
-    jekyll-avatar (0.7.0)
+      webrick (>= 1.0)
+    jekyll-avatar (0.8.0)
       jekyll (>= 3.0, < 5.0)
-    jekyll-coffeescript (1.1.1)
+    jekyll-coffeescript (1.2.2)
       coffee-script (~> 2.2)
-      coffee-script-source (~> 1.11.1)
+      coffee-script-source (~> 1.12)
     jekyll-commonmark (1.4.0)
       commonmarker (~> 0.22)
-    jekyll-commonmark-ghpages (0.4.0)
-      commonmarker (~> 0.23.7)
-      jekyll (~> 3.9.0)
+    jekyll-commonmark-ghpages (0.5.1)
+      commonmarker (>= 0.23.7, < 1.1.0)
+      jekyll (>= 3.9, < 4.0)
       jekyll-commonmark (~> 1.4.0)
       rouge (>= 2.0, < 5.0)
-    jekyll-default-layout (0.1.4)
-      jekyll (~> 3.0)
-    jekyll-feed (0.15.1)
+    jekyll-default-layout (0.1.5)
+      jekyll (>= 3.0, < 5.0)
+    jekyll-feed (0.17.0)
       jekyll (>= 3.7, < 5.0)
     jekyll-gist (1.5.0)
       octokit (~> 4.2)
-    jekyll-github-metadata (2.13.0)
+    jekyll-github-metadata (2.16.1)
       jekyll (>= 3.4, < 5.0)
-      octokit (~> 4.0, != 4.4.0)
+      octokit (>= 4, < 7, != 4.4.0)
     jekyll-include-cache (0.2.1)
       jekyll (>= 3.7, < 5.0)
     jekyll-mentions (1.6.0)
@@ -192,11 +196,11 @@ GEM
       jekyll (>= 3.3, < 5.0)
     jekyll-watch (2.2.1)
       listen (~> 3.0)
-    jemoji (0.12.0)
-      gemoji (~> 3.0)
+    jemoji (0.13.0)
+      gemoji (>= 3, < 5)
       html-pipeline (~> 2.2)
       jekyll (>= 3.0, < 5.0)
-    kramdown (2.3.2)
+    kramdown (2.4.0)
       rexml
     kramdown-parser-gfm (1.1.0)
       kramdown (~> 2.0)
@@ -205,27 +209,27 @@ GEM
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
     mercenary (0.3.6)
-    mini_portile2 (2.8.1)
+    mini_portile2 (2.8.8)
     minima (2.5.1)
       jekyll (>= 3.5, < 5.0)
       jekyll-feed (~> 0.9)
       jekyll-seo-tag (~> 2.1)
     minitest (5.19.0)
-    nokogiri (1.14.3)
-      mini_portile2 (~> 2.8.0)
+    nokogiri (1.18.8)
+      mini_portile2 (~> 2.8.2)
       racc (~> 1.4)
     octokit (4.25.1)
       faraday (>= 1, < 3)
       sawyer (~> 0.9)
     pathutil (0.16.2)
       forwardable-extended (~> 2.6)
     public_suffix (4.0.7)
-    racc (1.6.2)
+    racc (1.5.2)
     rb-fsevent (0.11.2)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
-    rexml (3.2.5)
-    rouge (3.26.0)
+    rexml (3.4.1)
+    rouge (3.30.0)
     ruby2_keywords (0.0.5)
     rubyzip (2.3.2)
     safe_yaml (1.0.5)
@@ -247,17 +251,23 @@ GEM
       concurrent-ruby (~> 1.0)
     unf (0.1.4)
       unf_ext
-    unf_ext (0.0.8.2)
+    unf_ext (0.0.7.7)
     unicode-display_width (1.8.0)
+    webrick (1.9.1)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  github-pages
+  commonmarker (~> 0.23.8)
+  eventmachine (~> 1.2.5)
+  github-pages (~> 232)
+  http_parser.rb (~> 0.6.0)
   jekyll-feed
   jekyll-redirect-from
   jekyll-sitemap
+  racc (~> 1.5.2)
+  unf_ext (~> 0.0.7.7)
 
 BUNDLED WITH
-   1.17.3
+   2.6.8

_config.yml

@@ -3,10 +3,10 @@ repository: tomjoht/documentation-theme-jekyll
 output: web
 # this property is useful for conditional filtering of content that is separate from the PDF.
 
-topnav_title: Tidal
+topnav_title: Tidal.cloud Guides
 # this appears on the top navigation bar next to the home button
 
-site_title: Tidal
+site_title: Tidal.cloud Guides
 # this appears in the html browser tab for the site title (seen mostly by search engines, not users)
 
 company_name: Tidal SW Inc

_data/sidebars/main_sidebar.yml

@@ -7,81 +7,81 @@ entries:
         folderitems:
           - title: Layering Discovery Techniques
             output: web
-            url: index.html
+            url: /index.html
           - title: Setup Tidal Tools
             output: web
-            url: tidal-tools.html
+            url: /tidal-tools.html
           - title: Setup Tidal Tools on AWS
             output: web
-            url: tidal-tools-aws.html
+            url: /tidal-tools-aws.html
           - title: Setup Tidal Tools on GCP
             output: web
-            url: tidal-tools-gcp.html
+            url: /tidal-tools-gcp.html
           - title: Tidal Tools Autocompletion
             output: web
-            url: autocompletion.html
+            url: /autocompletion.html
           - title: Tidal Offline
             output: web
-            url: tidal-offline.html
+            url: /tidal-offline.html
 
       - title: Discover
         output: web
         folderitems:
           - title: Importing Data From Excel
             output: web
-            url: import-from-excel.html
+            url: /import-from-excel.html
           - title: Bulk Editing Records
             output: web
-            url: bulk-edits.html
+            url: /bulk-edits.html
           - title: Tidal Discover
             output: web
-            url: discover.html
+            url: /discover.html
           - title: Public URL Discovery
             output: web
-            url: public-urls.html
+            url: /public-urls.html
           - title: Tidal Analyze
             output: web
-            url: analyze.html
+            url: /analyze.html
           - title: Sync your Server Inventory
             output: web
-            url: sync-servers.html
+            url: /sync-servers.html
           - title: Gathering Machine Stats
             output: web
-            url: machine_stats.html
+            url: /machine_stats.html
           - title: Host discovery with Nmap
             output: web
-            url: host-discovery.html
+            url: /host-discovery.html
           - title: Integrating with vSphere
             output: web
-            url: vsphere.html
+            url: /vsphere.html
           - title: Integrating with Ansible Tower
             output: web
-            url: ansible-tower.html
+            url: /ansible-tower.html
           - title: Integrating with Azure Migrate
             output: web
-            url: azure-migrate.html          
+            url: /azure-migrate.html          
           - title: Windows DNS Zonefile Export
             output: web
-            url: windows-zone-export.html
+            url: /windows-zone-export.html
           - title: Tidal Tools Virtual Machine Image
             output: web
-            url: tidal-discovery-vm.html
+            url: /tidal-discovery-vm.html
 
       - title: Assess
         output: web
         folderitems:
           - title: Code Analysis Overview
             output: web
-            url: code-analysis-overview.html
+            url: /code-analysis-overview.html
           - title: Performing Code Analysis
             output: web
-            url: analyze-source-code.html
+            url: /analyze-source-code.html
           - title: HTTP Web Log Analysis
             output: web
-            url: analyze-logs.html
+            url: /analyze-logs.html
           - title: Application Interview Best Practices
             output: web
-            url: interviews.html
+            url: /interviews.html
           - title: Creating interview questions
             output: web
             url: /create-interview-questions.html
@@ -146,17 +146,17 @@ entries:
         folderitems:
           - title: General Troubleshooting
             output: web
-            url: general-troubleshooting.html
+            url: /general-troubleshooting.html
           - title: Tidal Tools Troubleshooting
             output: web
-            url: troubleshooting.html
+            url: /troubleshooting.html
           - title: Troubleshooting Ansible Tower Integration
             output: web
-            url: troubleshoot-ansible.html
+            url: /troubleshoot-ansible.html
 
       - title: Downloads
         output: web
         folderitems:
           - title: Downloads
             output: web
-            url: downloads.html
+            url: /downloads.html

_data/strings.yml

@@ -1,5 +1,5 @@
 
 
 # placed here for translation purposes
-search_placeholder_text: search...
+search_placeholder_text: Search...
 search_no_results_text: No results found.