Skip to content

Commit 5084326

Browse files
jordanbreen28jordanbreen28
authored
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
2 parents 294bcfa + 5bc8f9e commit 5084326

File tree

17 files changed

+196
-749
lines changed

17 files changed

+196
-749
lines changed

‎.github/workflows/jekyll-gh-pages.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ jobs:
3232
- name: Build with Jekyll
3333
uses: actions/jekyll-build-pages@v1
3434
with:
35-
source: ./
35+
source: ./docs/
3636
destination: ./_site
3737
- name: Upload artifact
3838
uses: actions/upload-pages-artifact@v3

‎docs/_config.yml

+1
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ gfm_quirks: paragraph_end
88
lsi: false
99
safe: true
1010
incremental: false
11+
url: https://puppetlabs.github.io/rspec-puppet
1112
gist:
1213
noscript: false
1314
markdown: kramdown

‎docs/_layouts/base.html

+7-7
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,13 @@
1212
<meta name="author" content="">
1313
<link href='//fonts.googleapis.com/css?family=Open+Sans:300italic,400italic,600italic,700italic,800italic,400,300,600,700,800' rel='stylesheet' type='text/css'>
1414
<!-- Global CSS -->
15-
<link rel="stylesheet" href="/assets/plugins/bootstrap/css/bootstrap.min.css">
16-
<!-- Plugins CSS -->
17-
<link rel="stylesheet" href="/assets/plugins/font-awesome/css/font-awesome.css">
15+
<link rel="stylesheet" href="{{site.url}}/assets/plugins/bootstrap/css/bootstrap.min.css">
16+
<!-- Plugins CSS -->
17+
<link rel="stylesheet" href="{{site.url}}/assets/plugins/font-awesome/css/font-awesome.css">
1818

1919
<!-- Theme CSS -->
20-
<link id="theme-style" rel="stylesheet" href="/assets/css/styles.css">
21-
<link rel="stylesheet" href="/assets/css/monokai.css">
20+
<link id="theme-style" rel="stylesheet" href="{{site.url}}/assets/css/styles.css">
21+
<link rel="stylesheet" href="{{site.url}}/assets/css/monokai.css">
2222
<!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries -->
2323
<!--[if lt IE 9]>
2424
<script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
@@ -34,13 +34,13 @@
3434
<div class="container">
3535
<div class="branding">
3636
<h1 class="logo">
37-
<a href="/">
37+
<a href="{{site.url}}">
3838
<span class="text-highlight">rspec-puppet</span>
3939
</a>
4040
</h1>
4141
</div><!--//branding-->
4242
<ol class="breadcrumb">
43-
<li><a href="/">Home</a></li>
43+
<li><a href="{{site.url}}">Home</a></li>
4444
{% for crumb in page.breadcrumbs %}
4545
<li><a href="{{ crumb.path }}">{{ crumb.name }}</a></li>
4646
{% endfor %}

‎docs/_layouts/cards.html

+4-4
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,13 @@
1212
<meta name="author" content="">
1313
<link href='//fonts.googleapis.com/css?family=Open+Sans:300italic,400italic,600italic,700italic,800italic,400,300,600,700,800' rel='stylesheet' type='text/css'>
1414
<!-- Global CSS -->
15-
<link rel="stylesheet" href="/assets/plugins/bootstrap/css/bootstrap.min.css">
15+
<link rel="stylesheet" href="{{site.url}}/assets/plugins/bootstrap/css/bootstrap.min.css">
1616
<!-- Plugins CSS -->
17-
<link rel="stylesheet" href="/assets/plugins/font-awesome/css/font-awesome.css">
17+
<link rel="stylesheet" href="{{site.url}}/assets/plugins/font-awesome/css/font-awesome.css">
1818

1919
<!-- Theme CSS -->
20-
<link rel="stylesheet" href="/assets/css/monokai.css">
21-
<link id="theme-style" rel="stylesheet" href="/assets/css/styles.css">
20+
<link rel="stylesheet" href="{{site.url}}/assets/css/monokai.css">
21+
<link id="theme-style" rel="stylesheet" href="{{site.url}}/assets/css/styles.css">
2222
<!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries -->
2323
<!--[if lt IE 9]>
2424
<script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>

‎docs/changelog/index.md

+151-707
Large diffs are not rendered by default.

‎docs/documentation/classes/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ icon: fa fa-book
55
breadcrumbs:
66
-
77
name: Documentation
8-
path: /documentation/
8+
path: /rspec-puppet/documentation/
99
---
1010

1111
## Basic Test Structure

‎docs/documentation/configuration/index.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,11 @@ icon: fa fa-wrench
55
breadcrumbs:
66
-
77
name: Documentation
8-
path: /documentation/
8+
path: /rspec-puppet/documentation/
99
---
1010
rspec-puppet can be configured by modifying the `RSpec.configure` block in your
1111
`spec/spec_helper.rb` file. If you followed the [setup
12-
instructions](/documentation/setup/) you'll already have an `RSpec.configure`
12+
instructions]({{site.url}}/documentation/setup) you'll already have an `RSpec.configure`
1313
block that you can modify.
1414

1515
{% highlight ruby %}

‎docs/documentation/coverage/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ icon: fa fa-map-o
55
breadcrumbs:
66
-
77
name: Documentation
8-
path: /documentation/
8+
path: /rspec-puppet/documentation/
99
---
1010

1111
## Basic Report

‎docs/documentation/defined_types/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ icon: fa fa-copy
55
breadcrumbs:
66
-
77
name: Documentation
8-
path: /documentation/
8+
path: /rspec-puppet/documentation/
99
---
1010

1111
## Basic Test Structure

‎docs/documentation/functions/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ icon: fa fa-superscript
55
breadcrumbs:
66
-
77
name: Documentation
8-
path: /documentation/
8+
path: /rspec-puppet/documentation/
99
---
1010

1111
## Basic Test Structure

‎docs/documentation/hosts/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ icon: fa fa-server
55
breadcrumbs:
66
-
77
name: Documentation
8-
path: /documentation/
8+
path: /rspec-puppet/documentation/
99
---
1010

1111
## Basic Test Structure

‎docs/documentation/index.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -2,59 +2,59 @@
22
layout: cards
33
title: Documentation
44
icon: fa fa-files-o
5-
cards:
5+
cards:
66
-
77
title: Getting Started
88
text:
9-
path: /documentation/setup/
9+
path: setup/
1010
icon: fa fa-toggle-on
1111
colour: green
1212
-
1313
title: Configuration
1414
text:
15-
path: /documentation/configuration/
15+
path: configuration/
1616
icon: fa fa-wrench
1717
colour: blue
1818
-
1919
title: Testing Classes
2020
text:
21-
path: /documentation/classes/
21+
path: classes/
2222
icon: fa fa-book
2323
colour: pink
2424
-
2525
title: Testing Defined Types
2626
text:
27-
path: /documentation/defined_types/
27+
path: defined_types/
2828
icon: fa fa-copy
2929
colour: purple
3030
-
3131
title: Testing Functions
3232
text:
33-
path: /documentation/functions/
33+
path: functions/
3434
icon: fa fa-superscript
3535
colour: red
3636
-
3737
title: Testing Hosts
3838
text:
39-
path: /documentation/hosts/
39+
path: hosts/
4040
icon: fa fa-server
4141
colour: orange
4242
-
4343
title: Testing Types
4444
text:
45-
path: /documentation/types/
45+
path: types/
4646
icon: fa fa-puzzle-piece
4747
colour: blue
4848
-
4949
title: Testing Type Aliases
5050
text:
51-
path: /documentation/type_aliases/
51+
path: type_aliases/
5252
icon: fa fa-exchange
5353
colour: pink
5454
-
5555
title: Coverage Reports
5656
text:
57-
path: /documentation/coverage/
57+
path: coverage/
5858
icon: fa fa-map-o
5959
colour: purple
6060
---

‎docs/documentation/setup/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ icon: fa fa-toggle-on
55
breadcrumbs:
66
-
77
name: Documentation
8-
path: /documentation/
8+
path: /rspec-puppet/documentation/
99
---
1010
## Installation
1111

‎docs/documentation/type_aliases/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ icon: fa fa-exchange
55
breadcrumbs:
66
-
77
name: Documentation
8-
path: /documentation/
8+
path: /rspec-puppet/documentation/
99
---
1010

1111
## Basic Test Structure

‎docs/documentation/types/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ icon: fa fa-puzzle-piece
55
breadcrumbs:
66
-
77
name: Documentation
8-
path: /documentation/
8+
path: /rspec-puppet/documentation/
99
---
1010

1111
## Basic Test Structure

‎docs/index.html

+11-9
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
---
2+
13
<!DOCTYPE html>
24
<!--[if IE 8]> <html lang="en" class="ie8"> <![endif]-->
35
<!--[if IE 9]> <html lang="en" class="ie9"> <![endif]-->
@@ -12,13 +14,13 @@
1214
<meta name="author" content="">
1315
<link href='//fonts.googleapis.com/css?family=Open+Sans:300italic,400italic,600italic,700italic,800italic,400,300,600,700,800' rel='stylesheet' type='text/css'>
1416
<!-- Global CSS -->
15-
<link rel="stylesheet" href="assets/plugins/bootstrap/css/bootstrap.min.css">
17+
<link rel="stylesheet" href="{{ site.url }}/assets/plugins/bootstrap/css/bootstrap.min.css">
1618
<!-- Plugins CSS -->
17-
<link rel="stylesheet" href="assets/plugins/font-awesome/css/font-awesome.css">
18-
<link rel="stylesheet" href="assets/css/monokai.css">
19+
<link rel="stylesheet" href="{{ site.url }}/assets/plugins/font-awesome/css/font-awesome.css">
20+
<link rel="stylesheet" href="{{ site.url }}/assets/css/monokai.css">
1921

2022
<!-- Theme CSS -->
21-
<link id="theme-style" rel="stylesheet" href="assets/css/styles.css">
23+
<link id="theme-style" rel="stylesheet" href="{{ site.url }}/assets/css/styles.css">
2224
<!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries -->
2325
<!--[if lt IE 9]>
2426
<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>
5456
$ cd your-module
5557
$ rspec-puppet-init
5658
</code></pre></div>
57-
<p>Then continue on to the <a href="/tutorial/">tutorial!</a></p>
59+
<p>Then continue on to the <a href="{{ site.url }}/tutorial">tutorial!</a></p>
5860
<div class="cta-container">
59-
<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>
61+
<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>
6062
</div><!--//cta-container-->
6163
</div><!--//intro-->
6264
<div id="cards-wrapper" class="cards-wrapper row">
@@ -67,7 +69,7 @@ <h5>(The rest is a bit more difficult though)</h5>
6769
</div><!--//icon-holder-->
6870
<h3 class="title">Tutorial</h3>
6971
<p class="intro">A step-by-step introduction to behaviour-driven Puppet development</p>
70-
<a class="link" href="/tutorial/"><span></span></a>
72+
<a class="link" href="{{ site.url }}/tutorial"><span></span></a>
7173
</div><!--//item-inner-->
7274
</div><!--//item-->
7375
<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>
7779
</div><!--//icon-holder-->
7880
<h3 class="title">Documentation</h3>
7981
<p class="intro">Everything you need to know</p>
80-
<a class="link" href="/documentation/"><span></span></a>
82+
<a class="link" href="{{ site.url }}/documentation/"><span></span></a>
8183
</div><!--//item-inner-->
8284
</div><!--//item-->
8385
<div class="item item-purple col-md-4 col-sm-6 col-xs-6">
@@ -87,7 +89,7 @@ <h3 class="title">Documentation</h3>
8789
</div><!--//icon-holder-->
8890
<h3 class="title">Changelog</h3>
8991
<p class="intro">Check out what's changed in the latest release</p>
90-
<a class="link" href="/changelog/"><span></span></a>
92+
<a class="link" href="{{ site.url }}/changelog/"><span></span></a>
9193
</div><!--//item-inner-->
9294
</div><!--//item-->
9395
</div><!--//cards-->

‎docs/tutorial/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ _This is not intended to be an RSpec tutorial, just an explanation of how to
5656
use the extended functionality that rspec-puppet provides. If you are not
5757
familiar with the basics of RSpec, I highly recommend you take some time before
5858
continuing to read through the [RSpec
59-
documentation](https://www.relishapp.com/rspec)._
59+
documentation](https://rspec.info/documentation/)._
6060

6161
Lets say you're writing tests for a `logrotate::rule` type that does two
6262
things:

0 commit comments

Comments
 (0)