[SEO 8.] Add canonical url to API docs, remove news category (#221)

* Add canonical url to API docs * Remove news category from Jekyll
KnapsackPro · Dec 13, 2024 · 295d6d7 · 295d6d7
1 parent 43bc13c
commit 295d6d7
Show file tree

Hide file tree

Showing 9 changed files with 10 additions and 46 deletions.
diff --git a/_lib/tasks/api_doc.rake b/_lib/tasks/api_doc.rake
@@ -1,5 +1,6 @@
 namespace :api do
   task :generate_docs do
+    canonical_url = 'https://docs.knapsackpro.com/api/v1/'
     raml2html = 'node_modules/raml2html/bin/raml2html'
 
     raml_files = [
@@ -20,6 +21,14 @@ namespace :api do
       Kernel.system(cmd)
       exitstatus = $?.exitstatus
       if exitstatus.zero?
+        html = File
+          .read(html_file)
+          .gsub('<head>', <<~HEAD)
+            <head><link rel="canonical" href="#{canonical_url}" />
+          HEAD
+
+        File.open(html_file, 'w') { |f| f.write(html) }
+
         puts "Compilation done for #{file[:src]}. Generated the #{file[:dest]} file."
       else
         puts "Something failed during RAML to HTML compilation for #{raml_file}."

diff --git a/_posts/2015-04-04-welcome-to-knapsack-pro-documentation.md b/_posts/2015-04-04-welcome-to-knapsack-pro-documentation.md
diff --git a/_posts/2099-01-31-example-article.md b/_posts/2099-01-31-example-article.md
@@ -3,7 +3,7 @@ layout: post
 title:  "Example article"
 date:   2099-01-31 12:00:00 +0100
 author: "Artur Trzop"
-categories: techtips continuous_integration news
+categories: techtips continuous_integration
 og_image: "/images/blog/posts/example-article/image.jpg"
 published: false
 ---

diff --git a/algolia.config.json b/algolia.config.json
@@ -17,7 +17,6 @@
     "/blog",
     "/continuous_integration",
     "/tech_tips/",
-    "/news",
     "/api"
   ],
   "selectors": {

diff --git a/blog.html b/blog.html
@@ -12,7 +12,6 @@ <h1 class="post-title">Blog about testing & tech articles</h1>
 <i class="fas fa-file-alt"></i> <b>Blog articles</b> |
 <a href="{{ "/continuous_integration/" | prepend: site.baseurl }}"><i class="fas fa-cube"></i> <b>Continuous Integration</b></a> |
 <a href="{{ "/tech_tips/" | prepend: site.baseurl }}"><i class="fas fa-lightbulb"></i> <b>Tech tips</b></a> |
-<a href="{{ "/news/" | prepend: site.baseurl }}"><i class="fas fa-lightbulb"></i> <b>News</b></a>
 </p>
 
 <ul class="post-list">

diff --git a/continuous_integration.html b/continuous_integration.html
@@ -12,7 +12,6 @@ <h1 class="post-title">Continuous Integration</h1>
 <a href="{{ "/blog/" | prepend: site.baseurl }}"><i class="fas fa-file-alt"></i> <b>Blog articles</b></a> |
 <i class="fas fa-cube"></i> <b>Continuous Integration</b> |
 <a href="{{ "/tech_tips/" | prepend: site.baseurl }}"><i class="fas fa-lightbulb"></i> <b>Tech tips</b></a> |
-<a href="{{ "/news/" | prepend: site.baseurl }}"><i class="fas fa-lightbulb"></i> <b>News</b></a>
 </p>
 
 <ul class="post-list">

diff --git a/index.html b/index.html
@@ -10,7 +10,6 @@ <h1 class="post-title">Blog about testing & tech articles</h1>
 <i class="fas fa-file-alt"></i> <b>Blog articles</b> |
 <a href="{{ "/continuous_integration/" | prepend: site.baseurl }}"><i class="fas fa-cube"></i> <b>Continuous Integration</b></a> |
 <a href="{{ "/tech_tips/" | prepend: site.baseurl }}"><i class="fas fa-lightbulb"></i> <b>Tech tips</b></a> |
-<a href="{{ "/news/" | prepend: site.baseurl }}"><i class="fas fa-lightbulb"></i> <b>News</b></a>
 </p>
 
 <ul class="post-list">

diff --git a/news.html b/news.html
diff --git a/tech_tips.html b/tech_tips.html
@@ -12,7 +12,6 @@ <h1 class="post-title">Tech tips</h1>
 <a href="{{ "/blog/" | prepend: site.baseurl }}"><i class="fas fa-file-alt"></i> <b>Blog articles</b></a> |
 <a href="{{ "/continuous_integration/" | prepend: site.baseurl }}"><i class="fas fa-cube"></i> <b>Continuous Integration</b></a> |
 <i class="fas fa-lightbulb"></i> <b>Tech tips</b> |
-<a href="{{ "/news/" | prepend: site.baseurl }}"><i class="fas fa-lightbulb"></i> <b>News</b></a>
 </p>
 
 <ul class="post-list">