fix: have changelog be global to the website (#1420)

Signed-off-by: Charly Molter <charly.molter@konghq.com>
kumahq · Jul 18, 2023 · 4c2db25 · 4c2db25
1 parent 77bcdc0
commit 4c2db25
Show file tree

Hide file tree

Showing 8 changed files with 17 additions and 5 deletions.
diff --git a/app/_data/docs_nav_kuma_2.1.x.yml b/app/_data/docs_nav_kuma_2.1.x.yml
@@ -27,7 +27,9 @@ items:
       - text: Enterprise
         url: /introduction/enterprise/
       - text: Release notes
-        url: /introduction/changelog/
+        url: /docs/changelog/
+        absolute_url: true
+        generate: false
   - title: Install
     group: true
     items:

diff --git a/app/_data/docs_nav_kuma_2.2.x.yml b/app/_data/docs_nav_kuma_2.2.x.yml
@@ -24,7 +24,9 @@ items:
       - text: Kuma requirements
         url: /introduction/kuma-requirements/
       - text: Release notes
-        url: /introduction/changelog/
+        url: /docs/changelog/
+        absolute_url: true
+        generate: false
   - title: Kuma in Production
     group: true
     items:

diff --git a/app/_data/docs_nav_kuma_2.3.x.yml b/app/_data/docs_nav_kuma_2.3.x.yml
@@ -22,7 +22,9 @@ items:
       - text: Kuma requirements
         url: /introduction/kuma-requirements/
       - text: Release notes
-        url: /introduction/changelog/
+        url: /docs/changelog/
+        absolute_url: true
+        generate: false
   - title: Kuma in Production
     group: true
     items:

diff --git a/app/_data/docs_nav_kuma_dev.yml b/app/_data/docs_nav_kuma_dev.yml
@@ -22,7 +22,9 @@ items:
       - text: Kuma requirements
         url: /introduction/kuma-requirements/
       - text: Release notes
-        url: /introduction/changelog/
+        url: /docs/changelog/
+        absolute_url: true
+        generate: true
   - title: Kuma in Production
     group: true
     items:

diff --git a/app/_includes/version_alert.html b/app/_includes/version_alert.html
@@ -4,7 +4,7 @@
 {% assign latest_version_path = "docs/" | append: latest_version | append: '/' | append: page_path | append: '.md' %}
 {% assign latest_page = site.pages | find: 'path', latest_version_path %}
 
-{% if current_version != site.data.latest_version.release %}
+{% if current_version && current_version != site.data.latest_version.release %}
   <div>
     <div class="version-alert">
       <div class="warning custom-block">

diff --git a/app/_plugins/generators/navigation_links.rb b/app/_plugins/generators/navigation_links.rb
@@ -8,6 +8,7 @@ def generate(site)
       site.pages.each_with_index do |page, index|
         next unless page.relative_path.start_with? 'docs'
         next if page.path == 'docs/index.md'
+        next unless page.data.key? 'nav_items'
         # remove docs/<version>/ prefix and `.md` and the end
         page_url = page.path.gsub(/docs\/[^\/]+\//, '/').gsub('.md', '/')
 

diff --git a/app/_plugins/generators/versions.rb b/app/_plugins/generators/versions.rb
@@ -13,6 +13,8 @@ def generate(site)
       site.pages.each do |page|
         next unless page.url.start_with?('/docs/')
         version_data = version_from_page_url(page.url, site.data['versions'])
+        page.data['nav_items'] = {}
+        next unless version_data
         page.data['doc'] = true
         page.data['has_version'] = true
         page.data['version'] = version_data['release']

diff --git a/app/_src/introduction/changelog.md → app/docs/changelog.md b/app/_src/introduction/changelog.md → app/docs/changelog.md
@@ -1,5 +1,6 @@
 ---
 title: Release notes
+no_version: true
 ---
 
 {% embed raw/CHANGELOG.md %}