dss_tech_docs 0.1.0

data/dss_tech_docs.gemspec

@@ -0,0 +1,46 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "govuk_tech_docs/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "dss_tech_docs"
+  spec.version       = GovukTechDocs::VERSION
+  spec.authors       = ["Digital Shared Services"]
+  spec.email         = ["stephen.patterson@finance-ni.gov.uk"]
+
+  spec.summary       = %q{Gem to distribute the DSS Tech Docs Template}
+  spec.description   = %q{Gem to distribute the DSS Tech Docs Template. See https://github.com/dof-dss/tech-docs-gem for the project.}
+  spec.homepage      = "https://github.com/dof-dss/tech-docs-gem"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activesupport"
+  spec.add_dependency "chronic", "~> 0.10.2"
+  spec.add_dependency "middleman", "~> 4.0"
+  spec.add_dependency "middleman-autoprefixer", "~> 2.7.0"
+  spec.add_dependency "middleman-compass", ">= 4.0.0"
+  spec.add_dependency "middleman-livereload"
+  spec.add_dependency "middleman-sprockets", "~> 4.0.0"
+  spec.add_dependency "middleman-syntax", "~> 3.0.0"
+  spec.add_dependency 'middleman-search-gds', '~> 0.11.0a'
+  spec.add_dependency "nokogiri"
+  spec.add_dependency "redcarpet", "~> 3.3.2"
+  spec.add_dependency "openapi3_parser"
+  spec.add_dependency "pry"
+
+
+  spec.add_development_dependency "bundler", "~> 2.0.1"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "capybara", "~> 2.18.0"
+  spec.add_development_dependency "govuk-lint", "~> 3.7.0"
+  spec.add_development_dependency "jasmine", "~> 3.1.0"
+  spec.add_development_dependency "rspec", "~> 3.7.0"
+  spec.add_development_dependency "byebug"
+end

data/example/.ruby-version

@@ -0,0 +1 @@
+2.4.2

data/example/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gem 'govuk_tech_docs', path: '..'

data/example/config.rb

@@ -0,0 +1,9 @@
+require 'govuk_tech_docs'
+
+GovukTechDocs.configure(self)
+
+ignore 'templates/*'
+
+proxy '/a-proxied-page.html', 'templates/proxy_template.html', locals: {
+  title: 'I am a title'
+}

data/example/config/hide-expiry.yml

@@ -0,0 +1,51 @@
+# Host to use for canonical URL generation (without trailing slash)
+host: https://docs.example.com
+
+# Header-related options
+show_govuk_logo: true
+service_name: My First Service
+service_link: /
+phase: Beta
+
+# Links to show on right-hand-side of header
+header_links:
+  Documentation: /
+  Expired page: /expired-page.html
+  Expired with owner: /expired-page-with-owner.html
+  Not expired page: /not-expired-page.html
+
+# Tracking ID from Google Analytics (e.g. UA-XXXX-Y)
+ga_tracking_id:
+
+# Enable multipage navigation in the sidebar
+multipage_nav: true
+
+# Enable collapsible navigation in the sidebar
+collapsible_nav: true
+
+# Table of contents depth – how many levels to include in the table of contents.
+# If your ToC is too long, reduce this number and we'll only show higher-level
+# headings.
+max_toc_heading_level: 6
+
+# Prevent robots from indexing (e.g. whilst in development)
+prevent_indexing: false
+
+google_site_verification: dstbao8TVS^DRVDS&rv76
+
+enable_search: true
+
+show_contribution_banner: true
+
+github_repo: alphagov/example-repo
+github_branch: source
+
+redirects:
+  /something/old.html: /index.html
+
+api_path: source/pets.yml
+
+# Optional global settings for the page review process
+owner_slack_workspace: gds
+default_owner_slack: '#2nd-line'
+show_expiry: false

data/example/config/tech-docs.yml

@@ -0,0 +1,50 @@
+# Host to use for canonical URL generation (without trailing slash)
+host: https://docs.example.com
+
+# Header-related options
+show_govuk_logo: false
+service_name: DSS Tech Docs Example
+service_link: /
+phase: Beta
+
+# Links to show on right-hand-side of header
+header_links:
+  Documentation: /
+  Expired page: /expired-page.html
+  Expired with owner: /expired-page-with-owner.html
+  Not expired page: /not-expired-page.html
+
+# Tracking ID from Google Analytics (e.g. UA-XXXX-Y)
+ga_tracking_id:
+
+# Enable multipage navigation in the sidebar
+multipage_nav: true
+
+# Enable collapsible navigation in the sidebar
+collapsible_nav: true
+
+# Table of contents depth – how many levels to include in the table of contents.
+# If your ToC is too long, reduce this number and we'll only show higher-level
+# headings.
+max_toc_heading_level: 6
+
+# Prevent robots from indexing (e.g. whilst in development)
+prevent_indexing: false
+
+google_site_verification: dstbao8TVS^DRVDS&rv76
+
+enable_search: true
+
+show_contribution_banner: true
+
+github_repo: dof-dss/example-repo
+github_branch: source
+
+redirects:
+  /something/old.html: /index.html
+
+api_path: source/pets.yml
+
+# Optional global settings for the page review process
+owner_slack_workspace: gds
+default_owner_slack: '#2nd-line'

data/example/source/api-path.html.md

@@ -0,0 +1,7 @@
+---
+title: API /Pets
+---
+
+# API /Pets
+
+api> /pets

data/example/source/api-reference.html.md

@@ -0,0 +1,5 @@
+---
+title: Example API Petstore
+---
+
+api>

data/example/source/child-of-expired-page.html.md

@@ -0,0 +1,8 @@
+---
+title: This is a child of expired page
+parent: /expired-page.html
+---
+
+# This is a child of expired page
+
+Expired page should highlight in the navigation.

data/example/source/core-layout-without-sidebar.html.md.erb

@@ -0,0 +1,7 @@
+---
+layout: core
+---
+
+# Core layout, no sidebar
+
+This page does not have a sidebar.

data/example/source/core-layout.html.md.erb

@@ -0,0 +1,12 @@
+---
+layout: core
+---
+
+<% content_for :sidebar do %>
+  You can put anything in the sidebar.
+<% end %>
+
+
+# Core layout, alternative sidebar
+
+This page has a configurable sidebar that is independent of the content.

data/example/source/expired-page-with-owner.html.md

@@ -0,0 +1,10 @@
+---
+title: This is an expired page
+last_reviewed_on: 1983-01-18
+review_in: 18 years
+owner_slack: '@foo'
+---
+
+# This is an expired page with owner
+
+See the banner on this page.

data/example/source/expired-page.html.md

@@ -0,0 +1,9 @@
+---
+title: This is an expired page
+last_reviewed_on: 1983-01-18
+review_in: 18 years
+---
+
+# This is an expired page
+
+See the banner on this page.

data/example/source/headings.html.md

@@ -0,0 +1,11 @@
+---
+layout: layout
+---
+
+# The title
+
+## A subheader
+
+### A h3 subheader
+
+## Another subheader

data/example/source/index.html.md.erb

@@ -0,0 +1,19 @@
+---
+title: DSS Tech Docs Example
+old_paths:
+ - /something/old-as-well.html
+---
+
+# Hello, World!
+
+## Edit Me!
+
+Open `source/documentation/index.md` in your favourite text editor and start editing!
+
+You can write content in [Markdown](https://daringfireball.net/projects/markdown/) using **all** of the _usual_ syntax that you're used to!
+
+To change the title of the page or include additional files you'll need to edit `source/index.html.md.erb`.
+
+If you want slightly more control, you can always use <strong>HTML</strong>.
+
+For more detail and troubleshooting, take a look at the `README.md` file in the root of this project.

data/example/source/javascripts/application.js

@@ -0,0 +1 @@
+//= require govuk_tech_docs

data/example/source/not-expired-page.html.md

@@ -0,0 +1,9 @@
+---
+title: This is an expired page
+last_reviewed_on: 2050-01-18
+review_in: 1 month
+---
+
+# This is not an expired page
+
+See the banner on this page.

data/example/source/pets.yml

@@ -0,0 +1,109 @@
+openapi: "3.0.0"
+info:
+  version: 1.0.0
+  title: Swagger Petstore
+  description: A sample API that uses a petstore as an example to demonstrate features in the OpenAPI 3.0 specification
+  license:
+    name: MIT
+servers:
+  - description: Production
+    url: http://petstore.swagger.io/v1
+  - description: Development
+    url: http://dev.petstore.swagger.io
+paths:
+  /pets:
+    get:
+      summary: List all pets
+      operationId: listPets
+      tags:
+        - pets
+      parameters:
+        - name: limit
+          in: query
+          description: How many items to return at one time (max 100)
+          required: false
+          schema:
+            type: integer
+            format: int32
+      responses:
+        '200':
+          description: A paged array of pets
+          headers:
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Pets"
+        default:
+          description: unexpected error
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+    post:
+      summary: Create a pet
+      operationId: createPets
+      tags:
+        - pets
+      responses:
+        '201':
+          description: Null response
+        default:
+          description: unexpected error
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+  /pets/{petId}:
+    get:
+      summary: Info for a specific pet
+      operationId: showPetById
+      tags:
+        - pets
+      parameters:
+        - name: petId
+          in: path
+          required: true
+          description: The id of the pet to retrieve
+          schema:
+            type: string
+      responses:
+        '200':
+          description: Expected response to a valid request
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Pets"
+        default:
+          description: unexpected error
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+components:
+  schemas:
+    Pet:
+      required:
+        - id
+        - name
+      properties:
+        id:
+          type: integer
+          format: int64
+        name:
+          type: string
+        tag:
+          type: string
+    Pets:
+      type: array
+      items:
+        $ref: "#/components/schemas/Pet"
+    Error:
+      required:
+        - code
+        - message
+      properties:
+        code:
+          type: integer
+          format: int32
+        message:
+          type: string

data/example/source/stylesheets/print.css.scss

@@ -0,0 +1,3 @@
+$is-print: true;
+
+@import "govuk_tech_docs";

data/example/source/stylesheets/screen-old-ie.css.scss

@@ -0,0 +1,4 @@
+$is-ie: true;
+$ie-version: 8;
+
+@import "govuk_tech_docs";

data/example/source/stylesheets/screen.css.scss

@@ -0,0 +1 @@
+@import "govuk_tech_docs";

data/example/source/templates/proxy_template.html.md

@@ -0,0 +1,8 @@
+---
+title: Proxied page
+source_url: http://example.org/source.md
+---
+
+# Proxied page
+
+This is a proxied page.

data/lib/assets/javascripts/_analytics.js

@@ -0,0 +1,58 @@
+(function($) {
+  function trackLinkClick(action, $element) {
+    var linkText = $.trim($element.text());
+    var linkURL = $element.attr('href');
+    var label = linkText + '|' + linkURL;
+
+    ga(
+      'send',
+      'event',
+      'SM Technical Documentation', // Event Category
+      action, // Event Action
+      label // Event Label
+    );
+  }
+
+  function linkTrackingEventHandler(action) {
+    return function() {
+      trackLinkClick(action, $(this));
+    };
+  };
+
+  function catchBrokenFragmentLinks() {
+    var fragment = window.location.hash;
+    var $target = $(fragment);
+    if(!$target.get(0)) {
+      ga(
+        'send',
+        'event',
+        'Broken fragment ID', // Event Category
+        'pageview', // Event Action
+        window.location.pathname + fragment // Event Label
+      );
+    }
+  }
+
+  $(document).on('ready', function() {
+    if (typeof ga === 'undefined') {
+      return;
+    }
+
+    $('.technical-documentation a').on('click', linkTrackingEventHandler('inTextClick'));
+    $('.header a').on('click', linkTrackingEventHandler('topNavigationClick'));
+    $('.toc a').on('click', linkTrackingEventHandler('tableOfContentsNavigationClick'));
+    catchBrokenFragmentLinks();
+
+    // Borrowed from:
+    // https://github.com/alphagov/govuk_frontend_toolkit/blob/master/javascripts/govuk/analytics/analytics.js
+    window.stripPIIFromString = function (string) {
+      var EMAIL_PATTERN = /[^\s=/?&]+(?:@|%40)[^\s=/?&]+/g
+      var POSTCODE_PATTERN = /[A-PR-UWYZ][A-HJ-Z]?[0-9][0-9A-HJKMNPR-Y]?(?:[\s+]|%20)*[0-9][ABD-HJLNPQ-Z]{2}/gi
+      var DATE_PATTERN = /\d{4}(-?)\d{2}(-?)\d{2}/g
+      var stripped = string.replace(EMAIL_PATTERN, '[email]')
+      .replace(DATE_PATTERN, '[date]')
+      .replace(POSTCODE_PATTERN, '[postcode]');
+      return stripped
+    }
+  });
+})(jQuery);