Merge pull request #123 from puppetlabs/cat_1930

Set correct source directory for jekyll gh-action page and add {{ site.ur l}} to fix links and styling
puppetlabs · Jul 10, 2024 · 5084326 · 5084326
2 parents 294bcfa + 5bc8f9e
commit 5084326
Show file tree

Hide file tree

Showing 17 changed files with 196 additions and 749 deletions.
diff --git a/.github/workflows/jekyll-gh-pages.yml b/.github/workflows/jekyll-gh-pages.yml
@@ -32,7 +32,7 @@ jobs:
       - name: Build with Jekyll
         uses: actions/jekyll-build-pages@v1
         with:
-          source: ./
+          source: ./docs/
           destination: ./_site
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v3

diff --git a/docs/_config.yml b/docs/_config.yml
@@ -8,6 +8,7 @@ gfm_quirks: paragraph_end
 lsi: false
 safe: true
 incremental: false
+url: https://puppetlabs.github.io/rspec-puppet
 gist:
     noscript: false
 markdown: kramdown
diff --git a/docs/_layouts/base.html b/docs/_layouts/base.html
@@ -12,13 +12,13 @@
     <meta name="author" content="">    
     <link href='//fonts.googleapis.com/css?family=Open+Sans:300italic,400italic,600italic,700italic,800italic,400,300,600,700,800' rel='stylesheet' type='text/css'>
     <!-- Global CSS -->
-    <link rel="stylesheet" href="/assets/plugins/bootstrap/css/bootstrap.min.css">   
-    <!-- Plugins CSS -->    
-    <link rel="stylesheet" href="/assets/plugins/font-awesome/css/font-awesome.css">
+    <link rel="stylesheet" href="{{site.url}}/assets/plugins/bootstrap/css/bootstrap.min.css">   
+    <!-- Plugins CSS -->
+    <link rel="stylesheet" href="{{site.url}}/assets/plugins/font-awesome/css/font-awesome.css">
 
     <!-- Theme CSS -->
-    <link id="theme-style" rel="stylesheet" href="/assets/css/styles.css">
-    <link rel="stylesheet" href="/assets/css/monokai.css">
+    <link id="theme-style" rel="stylesheet" href="{{site.url}}/assets/css/styles.css">
+    <link rel="stylesheet" href="{{site.url}}/assets/css/monokai.css">
     <!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries -->
     <!--[if lt IE 9]>
       <script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
@@ -34,13 +34,13 @@
             <div class="container">
                 <div class="branding">
                     <h1 class="logo">
-                        <a href="/">
+                        <a href="{{site.url}}">
                             <span class="text-highlight">rspec-puppet</span>
                         </a>
                     </h1>
                 </div><!--//branding-->
                 <ol class="breadcrumb">
-                    <li><a href="/">Home</a></li>
+                    <li><a href="{{site.url}}">Home</a></li>
 {% for crumb in page.breadcrumbs %}
                     <li><a href="{{ crumb.path }}">{{ crumb.name }}</a></li>
 {% endfor %}

diff --git a/docs/_layouts/cards.html b/docs/_layouts/cards.html
@@ -12,13 +12,13 @@
     <meta name="author" content="">    
     <link href='//fonts.googleapis.com/css?family=Open+Sans:300italic,400italic,600italic,700italic,800italic,400,300,600,700,800' rel='stylesheet' type='text/css'>
     <!-- Global CSS -->
-    <link rel="stylesheet" href="/assets/plugins/bootstrap/css/bootstrap.min.css">   
+    <link rel="stylesheet" href="{{site.url}}/assets/plugins/bootstrap/css/bootstrap.min.css">   
     <!-- Plugins CSS -->    
-    <link rel="stylesheet" href="/assets/plugins/font-awesome/css/font-awesome.css">
+    <link rel="stylesheet" href="{{site.url}}/assets/plugins/font-awesome/css/font-awesome.css">
 
     <!-- Theme CSS -->
-    <link rel="stylesheet" href="/assets/css/monokai.css">
-    <link id="theme-style" rel="stylesheet" href="/assets/css/styles.css">
+    <link rel="stylesheet" href="{{site.url}}/assets/css/monokai.css">
+    <link id="theme-style" rel="stylesheet" href="{{site.url}}/assets/css/styles.css">
     <!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries -->
     <!--[if lt IE 9]>
       <script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>

diff --git a/docs/changelog/index.md b/docs/changelog/index.md
diff --git a/docs/documentation/classes/index.md b/docs/documentation/classes/index.md
@@ -5,7 +5,7 @@ icon: fa fa-book
 breadcrumbs:
     -
         name: Documentation
-        path: /documentation/
+        path: /rspec-puppet/documentation/
 ---
 
 ## Basic Test Structure

diff --git a/docs/documentation/configuration/index.md b/docs/documentation/configuration/index.md
@@ -5,11 +5,11 @@ icon: fa fa-wrench
 breadcrumbs:
     -
         name: Documentation
-        path: /documentation/
+        path: /rspec-puppet/documentation/
 ---
 rspec-puppet can be configured by modifying the `RSpec.configure` block in your
 `spec/spec_helper.rb` file. If you followed the [setup
-instructions](/documentation/setup/) you'll already have an `RSpec.configure`
+instructions]({{site.url}}/documentation/setup) you'll already have an `RSpec.configure`
 block that you can modify.
 
 {% highlight ruby %}

diff --git a/docs/documentation/coverage/index.md b/docs/documentation/coverage/index.md
@@ -5,7 +5,7 @@ icon: fa fa-map-o
 breadcrumbs:
     -
         name: Documentation
-        path: /documentation/
+        path: /rspec-puppet/documentation/
 ---
 
 ## Basic Report

diff --git a/docs/documentation/defined_types/index.md b/docs/documentation/defined_types/index.md
@@ -5,7 +5,7 @@ icon: fa fa-copy
 breadcrumbs:
     -
         name: Documentation
-        path: /documentation/
+        path: /rspec-puppet/documentation/
 ---
 
 ## Basic Test Structure

diff --git a/docs/documentation/functions/index.md b/docs/documentation/functions/index.md
@@ -5,7 +5,7 @@ icon: fa fa-superscript
 breadcrumbs:
     -
         name: Documentation
-        path: /documentation/
+        path: /rspec-puppet/documentation/
 ---
 
 ## Basic Test Structure

diff --git a/docs/documentation/hosts/index.md b/docs/documentation/hosts/index.md
@@ -5,7 +5,7 @@ icon: fa fa-server
 breadcrumbs:
     -
         name: Documentation
-        path: /documentation/
+        path: /rspec-puppet/documentation/
 ---
 
 ## Basic Test Structure

diff --git a/docs/documentation/index.md b/docs/documentation/index.md
@@ -2,59 +2,59 @@
 layout: cards
 title: Documentation
 icon: fa fa-files-o
-cards:
+cards:  
     -
         title: Getting Started
         text:
-        path: /documentation/setup/
+        path: setup/
         icon: fa fa-toggle-on
         colour: green
     -
         title: Configuration
         text:
-        path: /documentation/configuration/
+        path: configuration/
         icon: fa fa-wrench
         colour: blue
     -
         title: Testing Classes
         text:
-        path: /documentation/classes/
+        path: classes/
         icon: fa fa-book
         colour: pink
     -
         title: Testing Defined Types
         text:
-        path: /documentation/defined_types/
+        path: defined_types/
         icon: fa fa-copy
         colour: purple
     -
         title: Testing Functions
         text:
-        path: /documentation/functions/
+        path: functions/
         icon: fa fa-superscript
         colour: red
     -
         title: Testing Hosts
         text:
-        path: /documentation/hosts/
+        path: hosts/
         icon: fa fa-server
         colour: orange
     -
         title: Testing Types
         text:
-        path: /documentation/types/
+        path: types/
         icon: fa fa-puzzle-piece
         colour: blue
     -
         title: Testing Type Aliases
         text:
-        path: /documentation/type_aliases/
+        path: type_aliases/
         icon: fa fa-exchange
         colour: pink
     -
         title: Coverage Reports
         text:
-        path: /documentation/coverage/
+        path: coverage/
         icon: fa fa-map-o
         colour: purple
 ---
diff --git a/docs/documentation/setup/index.md b/docs/documentation/setup/index.md
@@ -5,7 +5,7 @@ icon: fa fa-toggle-on
 breadcrumbs:
     -
         name: Documentation
-        path: /documentation/
+        path: /rspec-puppet/documentation/
 ---
 ## Installation
 

diff --git a/docs/documentation/type_aliases/index.md b/docs/documentation/type_aliases/index.md
@@ -5,7 +5,7 @@ icon: fa fa-exchange
 breadcrumbs:
     -
         name: Documentation
-        path: /documentation/
+        path: /rspec-puppet/documentation/
 ---
 
 ## Basic Test Structure

diff --git a/docs/documentation/types/index.md b/docs/documentation/types/index.md
@@ -5,7 +5,7 @@ icon: fa fa-puzzle-piece
 breadcrumbs:
     -
         name: Documentation
-        path: /documentation/
+        path: /rspec-puppet/documentation/
 ---
 
 ## Basic Test Structure

diff --git a/docs/index.html b/docs/index.html
@@ -1,3 +1,5 @@
+--- 
+
 <!DOCTYPE html>
 <!--[if IE 8]> <html lang="en" class="ie8"> <![endif]-->  
 <!--[if IE 9]> <html lang="en" class="ie9"> <![endif]-->  
@@ -12,13 +14,13 @@
     <meta name="author" content="">    
     <link href='//fonts.googleapis.com/css?family=Open+Sans:300italic,400italic,600italic,700italic,800italic,400,300,600,700,800' rel='stylesheet' type='text/css'>
     <!-- Global CSS -->
-    <link rel="stylesheet" href="assets/plugins/bootstrap/css/bootstrap.min.css">   
+    <link rel="stylesheet" href="{{ site.url }}/assets/plugins/bootstrap/css/bootstrap.min.css">   
     <!-- Plugins CSS -->    
-    <link rel="stylesheet" href="assets/plugins/font-awesome/css/font-awesome.css">
-    <link rel="stylesheet" href="assets/css/monokai.css">
+    <link rel="stylesheet" href="{{ site.url }}/assets/plugins/font-awesome/css/font-awesome.css">
+    <link rel="stylesheet" href="{{ site.url }}/assets/css/monokai.css">
 
     <!-- Theme CSS -->
-    <link id="theme-style" rel="stylesheet" href="assets/css/styles.css">
+    <link id="theme-style" rel="stylesheet" href="{{ site.url }}/assets/css/styles.css">
     <!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries -->
     <!--[if lt IE 9]>
       <script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
@@ -54,9 +56,9 @@ <h5>(The rest is a bit more difficult though)</h5>
 $ cd your-module
 $ rspec-puppet-init
                         </code></pre></div>
-                    <p>Then continue on to the <a href="/tutorial/">tutorial!</a></p>
+                    <p>Then continue on to the <a href="{{ site.url }}/tutorial">tutorial!</a></p>
                     <div class="cta-container">
-                        <a class="btn btn-primary btn-cta" href="https://github.com/rodjek/rspec-puppet/" target="_blank"><i class="fa fa-github"></i> View on GitHub</a>
+                        <a class="btn btn-primary btn-cta" href="https://github.com/puppetlabs/rspec-puppet" target="_blank"><i class="fa fa-github"></i> View on GitHub</a>
                     </div><!--//cta-container-->
                 </div><!--//intro-->
                 <div id="cards-wrapper" class="cards-wrapper row">
@@ -67,7 +69,7 @@ <h5>(The rest is a bit more difficult though)</h5>
                             </div><!--//icon-holder-->
                             <h3 class="title">Tutorial</h3>
                             <p class="intro">A step-by-step introduction to behaviour-driven Puppet development</p>
-                            <a class="link" href="/tutorial/"><span></span></a>
+                            <a class="link" href="{{ site.url }}/tutorial"><span></span></a>
                         </div><!--//item-inner-->
                     </div><!--//item-->
                     <div class="item item-pink item-2 col-md-4 col-sm-6 col-xs-6">
@@ -77,7 +79,7 @@ <h3 class="title">Tutorial</h3>
                             </div><!--//icon-holder-->
                             <h3 class="title">Documentation</h3>
                             <p class="intro">Everything you need to know</p>
-                            <a class="link" href="/documentation/"><span></span></a>
+                            <a class="link" href="{{ site.url }}/documentation/"><span></span></a>
                         </div><!--//item-inner-->
                     </div><!--//item-->
                     <div class="item item-purple col-md-4 col-sm-6 col-xs-6">
@@ -87,7 +89,7 @@ <h3 class="title">Documentation</h3>
                             </div><!--//icon-holder-->
                             <h3 class="title">Changelog</h3>
                             <p class="intro">Check out what's changed in the latest release</p>
-                            <a class="link" href="/changelog/"><span></span></a>
+                            <a class="link" href="{{ site.url }}/changelog/"><span></span></a>
                         </div><!--//item-inner-->
                     </div><!--//item-->
                 </div><!--//cards-->

diff --git a/docs/tutorial/index.md b/docs/tutorial/index.md
@@ -56,7 +56,7 @@ _This is not intended to be an RSpec tutorial, just an explanation of how to
 use the extended functionality that rspec-puppet provides.  If you are not
 familiar with the basics of RSpec, I highly recommend you take some time before
 continuing to read through the [RSpec 
-documentation](https://www.relishapp.com/rspec)._
+documentation](https://rspec.info/documentation/)._
 
 Lets say you're writing tests for a `logrotate::rule` type that does two
 things: