From bb5ec3fd7c05f6a73384a82ca6a866dadf44fdd2 Mon Sep 17 00:00:00 2001 From: Dana Doherty Date: Tue, 2 Jul 2024 14:49:30 +0100 Subject: [PATCH] (CAT-1930) - fix build dir for jekyll gh-actions, links and stying --- .github/workflows/jekyll-gh-pages.yml | 2 +- docs/_config.yml | 1 + docs/_layouts/base.html | 12 ++++++------ docs/_layouts/cards.html | 8 ++++---- docs/documentation/classes/index.md | 2 +- docs/documentation/configuration/index.md | 2 +- docs/documentation/coverage/index.md | 2 +- docs/documentation/defined_types/index.md | 2 +- docs/documentation/functions/index.md | 2 +- docs/documentation/hosts/index.md | 2 +- docs/documentation/index.md | 20 ++++++++++---------- docs/documentation/setup/index.md | 2 +- docs/documentation/type_aliases/index.md | 2 +- docs/documentation/types/index.md | 2 +- docs/index.html | 20 +++++++++++--------- docs/tutorial/index.md | 2 +- 16 files changed, 43 insertions(+), 40 deletions(-) diff --git a/.github/workflows/jekyll-gh-pages.yml b/.github/workflows/jekyll-gh-pages.yml index 14b691c66..5cacb2115 100644 --- 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 index 5b27d48f4..61148845c 100644 --- 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 index 8cfb85f7a..939e9d84a 100644 --- a/docs/_layouts/base.html +++ b/docs/_layouts/base.html @@ -12,13 +12,13 @@ - - - + + + - - + +
    -
  1. Home
    2. +
  2. Home
    3. {% for crumb in page.breadcrumbs %}
  3. {{ crumb.name }}
    4. {% endfor %} diff --git a/docs/_layouts/cards.html b/docs/_layouts/cards.html index 393d18671..d5c1fc2fd 100644 --- a/docs/_layouts/cards.html +++ b/docs/_layouts/cards.html @@ -12,13 +12,13 @@ - + - + - - + + @@ -12,13 +14,13 @@ - + - - + + - +
    @@ -67,7 +69,7 @@
    (The rest is a bit more difficult though)

    Tutorial

    A step-by-step introduction to behaviour-driven Puppet development

    - +
    @@ -77,7 +79,7 @@

    Tutorial

    Documentation

    Everything you need to know

    - +
    @@ -87,7 +89,7 @@

    Documentation

    Changelog

    Check out what's changed in the latest release

    - + diff --git a/docs/tutorial/index.md b/docs/tutorial/index.md index e0a5d1add..7c58e4258 100644 --- 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: