dss_tech_docs 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 15e8faf0fa987026cd291cbf0eaa5b2b962d4856
-  data.tar.gz: 6347f8673da6972206dcdd3cc4236ff5ffa26244
+  metadata.gz: d1d8d54f8191a15f8d4d0405d22390cfe69fb8db
+  data.tar.gz: 51656918318c8e4cd56e14232a92e6716f52844f
 SHA512:
-  metadata.gz: 9d1b07ce838ab225aa19ec2513e9b1d8e7f01fa72427ca9ebbac8227151b3380988c074bcfef46cc235c119afbcaaf104f14baabe0756a2e614612de99bb4e5c
-  data.tar.gz: 1e3a0cb054def4f45ea8257c6c0d95bb769313f9dfcf491d431ff4f92bdb08668304cef8746b4a3df9c264efa0086b37c547597c6b59aed520a73524c99de7b3
+  metadata.gz: 9f8beb1dbf8b9059c1ca590f27536a7912701e8f600492c666497e24421ad6c7392c3ce4a8b9196b834673480b18932b3b7ba42fc03c4da16059f79e116edbf5
+  data.tar.gz: b1d4fc6ce585bd6f1aa9eb915be24ca539873ca725a222016be1e8128524383832c2ddd23687d9aafe409191b18075755c9941fb14d549f206c1e337fbc6d28d

data/CHANGELOG.md

@@ -1,274 +1,9 @@
 # Changelog
 
-## 1.8.2
+## 0.1.0
 
-Adds a `show_expiry` config option to allow you to choose whether to show the review due date and expired banner from your pages. Find out more about the [page expiry and review feature][expiry].
+Initial copy from govuk_tech_docs and styling changes made for DSS.
 
-[expiry]: https://tdt-documentation.london.cloudapps.digital/page-expiry.html#page-expiry-and-review
+## 0.1.1
 
-## 1.8.1
-
-This release fixes a bug (#79 - reported in
-[alphagov/tech-docs-template#183][tdt-183]) which prevented a multipage site
-from being generated when a custom `http_prefix` was configured.
-
-[tdt-183]: https://github.com/alphagov/tech-docs-template/issues/183
-
-## 1.8.0
-
-🎉 Our first contributor from outside of GDS. Thanks [@timja](https://github.com/timja) from [HMCTS](https://hmcts.github.io)! 🤝
-
-New features: you can now configure a different GitHub branch for the repo to generate the "View source" link in the footer. Use `github_branch` in your config file (#71). You can also specify a `full_service_name` in the config, which is used in the browser title and meta tags (#72).
-
-This version also fixes a bug with unclickable links (#74 - reported in [alphagov/tech-docs-template#123](https://github.com/alphagov/tech-docs-template/issues/123)).
-
-## 1.7.0
-
-New features: this release adds support for a full-width page (#63) and adding HTML to the `head` of the page (#64).
-
-This release also makes sure that all pages are returned in the `/api/pages.json` endpoint (#66).
-
-## 1.6.3
-
-The gem now uses `middleman-search-gds` rather than `middleman-search`, which
-removes the need for projects to point to the alphagov github repository in
-their Gemfiles. We will continue to maintain our own fork until the changes
-are merged into the upstream project.
-
-## 1.6.2
-
-This version fixes an issue with Middleman hanging (PR #54). It also allows the API reference page to include multiple servers and their descriptions (PR #53).
-
-## 1.6.1
-
-### Make `api_path` configuration optional
-
-A bug in the previous release prevented the docs from being generated if
-`api_path` was missing. This is now fixed.
-
-## 1.6.0
-
-Version 1.6.0 adds API reference generation, and improves the search function.
-
-### New feature: API reference
-
-Specify an OpenAPI spec file using `api_path`, for example: `api_path: source/pets.yml`.
-
-To output the generated content in the page of your choice, write `api>` in any markdown parsed file (.md, .html.md, .html.md.erb). You can also specify to just print a specific path: `api> /pets`
-
-This generates request and response schemas and examples for each API operation.
-
-More info:
-
-- https://github.com/alphagov/tech-docs-gem/pull/40
-- https://github.com/alphagov/tech-docs-gem/pull/48
-
-### Search result improvements
-
-The search indexing pipeline has been tweaked to provide expected results. The display of the search results has also been
-
-If you're using search then you'll need to add this line to your project `Gemfile`:
-
-```
-gem 'middleman-search', git: 'git://github.com/alphagov/middleman-search.git'
-```
-
-More info:
-- https://github.com/alphagov/tech-docs-gem/pull/37
-- https://github.com/alphagov/tech-docs-gem/pull/38
-- https://github.com/alphagov/tech-docs-gem/pull/41
-- https://github.com/alphagov/tech-docs-gem/pull/42
-- https://github.com/alphagov/tech-docs-gem/pull/43
-
-### Correct fork of middleman in example project
-
-The example gem project now uses alphagov/middleman-search. This prevents `bundle exec middleman serve` from crashing.
-
-More info:
-- https://github.com/alphagov/tech-docs-gem/pull/35
-
-### Accessibility improvements
-
-Accessibility improvements to search, collapsible navigation, and the logo.
-
-More info:
-- https://github.com/alphagov/tech-docs-gem/pull/36
-- https://github.com/alphagov/tech-docs-gem/pull/33
-
-### Additional configuration options for review system
-
-`default_owner_slack` and `owner_slack_workspace` are now configurable for use within the review system.
-
-More info:
-- https://github.com/alphagov/tech-docs-gem/pull/47
-
-### Correct fork of middleman in example project
-
-The example gem project now uses alphagov/middleman-search. This prevents `bundle exec middleman serve` from crashing.
-
-More info:
-- https://github.com/alphagov/tech-docs-gem/pull/35
-
-### Accessibility improvements
-
-Accessibility improvements to search, collapsible navigation, and the logo.
-
-More info:
-- https://github.com/alphagov/tech-docs-gem/pull/36
-- https://github.com/alphagov/tech-docs-gem/pull/33
-
-### Search result improvements
-
-The search indexing pipeline has been tweaked to provide expected results. The display of the search results has also been improved.
-
-If you're using search then you'll need to add this line to your project `Gemfile`:
-
-```
-gem 'middleman-search', git: 'git://github.com/alphagov/middleman-search.git'
-```
-
-More info:
-- https://github.com/alphagov/tech-docs-gem/pull/37
-- https://github.com/alphagov/tech-docs-gem/pull/38
-- https://github.com/alphagov/tech-docs-gem/pull/41
-- https://github.com/alphagov/tech-docs-gem/pull/42
-- https://github.com/alphagov/tech-docs-gem/pull/43
-
-## 1.5.0
-
-### New feature: Search
-
-Adds search functionality. This indexes pages only and is not recommended for single-page sites. To enable write `enable_search: true` in in tech-docs.yml.
-
-More info:
-- https://github.com/alphagov/tech-docs-gem/pull/28
-
-### Google Analytics tracking for old headings
-
-An event category 'Broken fragment ID' will be pushed to Google Analytics when a user lands on a page with a URL that points to a fragment ID that does not exist on the page.
-
-More info:
-- https://github.com/alphagov/tech-docs-gem/pull/30
-
-## 1.4.0
-
-Adds multiple page navigation support and collapsible top level navigation
-items. When enabled the table of contents will display other pages on the site.
-
-More info:
-- https://github.com/alphagov/tech-docs-gem/pull/27
-
-## 1.3.1
-
-Minor update to Google Analytics tracking
-
-More info:
-- https://github.com/alphagov/tech-docs-gem/pull/25
-
-## 1.3.0
-
-Version 1.3.0 contains accessibility fixes (#20) and a fix to make the
-site more robust when certain options aren't set in the configs (#17).
-
-### New feature: passing options to `GovukTechDocs.configure`
-
-You can now pass options into `GovukTechDocs.configure` for the `livereload`
-extension.
-
-```rb
-GovukTechDocs.configure(self, livereload: { js_host: 'localhost' })
-```
-
-See PR #18.
-
-### New feature: page parents
-
-You can now specify a page’s parent in its frontmatter. This affects
-which item is selected in the navigation.
-
-More info:
-
-- https://github.com/alphagov/tech-docs-gem/pull/19
-- https://github.com/alphagov/tech-docs-gem/blob/master/docs/frontmatter.md#parent
-
-## 1.2.0
-
-### New feature: redirects
-
-You can now specify redirects in the frontmatter and `config/tech-docs.yml`.
-
-You can use this when you change a page URL.
-
-More info:
-
-- https://github.com/alphagov/tech-docs-gem/blob/master/docs/configuration.md#redirects
-- https://github.com/alphagov/tech-docs-gem/blob/master/docs/frontmatter.md#old_paths
-
-### New feature: contribution banner
-
-You can now show a block at the bottom of the page that links to
-the page source on GitHub, so readers can easily contribute back to the documentation.
-
-https://github.com/alphagov/tech-docs-gem/blob/master/docs/configuration.md#show_contribution_banner
-
-### New feature: page review system
-
-An optional page review system to make sure documentation stays up to date.
-
-More info:
-
-- https://github.com/alphagov/tech-docs-gem/blob/master/docs/frontmatter.md#last_reviewed_on
-- https://github.com/alphagov/tech-docs-gem/blob/master/docs/frontmatter.md#owner_slack
-
-
-### Better meta tags
-
-Pages now include better meta tags for search engines, Twitter, Facebook and Slack to pick up.
-
-## 1.1.0
-
-You can now specify `google_site_verification` in tech-docs.yml. You can use
-this to verify your site in Google Webmaster tools.
-
-https://github.com/alphagov/tech-docs-gem/blob/master/docs/configuration.md#google_site_verification
-
-## 1.0.0
-
-The first release of the template as a gem. Most CSS, JS, images and layouts are
-now imported from the gem and can be removed from your project.
-
-The following script upgrades your project. This will work if you've not made
-any modifications to the files distributed by the template. If you have, you'll
-need to port your changes back in.
-
-```sh
-rm -rf lib source/images source/layouts source/favicon.ico source/javascripts/* source/stylesheets/*
-
-echo "//= require govuk_tech_docs" > source/javascripts/application.js
-echo "@import 'govuk_tech_docs';" > source/stylesheets/screen.css.scss
-
-echo '$is-print: true;
-
-@import "govuk_tech_docs";' > source/stylesheets/print.css.scss
-
-echo '$is-ie: true;
-$ie-version: 8;
-
-@import "govuk_tech_docs";' > source/stylesheets/screen-old-ie.css.scss
-
-echo "require 'govuk_tech_docs'
-
-GovukTechDocs.configure(self)" > config.rb
-
-echo "source 'https://rubygems.org'
-
-# For faster file watcher updates on Windows:
-gem 'wdm', '~> 0.1.0', platforms: [:mswin, :mingw]
-
-# Windows does not come with time zone data
-gem 'tzinfo-data', platforms: [:mswin, :mingw, :jruby]
-
-gem 'govuk_tech_docs'" > Gemfile
-
-bundle install
-```
+Include the Lato font in the header as the GOV.UK NTA font has been overridden

data/CONTRIBUTING.md

@@ -1,9 +1,3 @@
 ## Contributing to this project
 
-Everybody who uses this project is encouraged to contribute to this project. If you're part of the [alphagov GitHub organisation](https://www.github.com/alphagov) you probably have write access to this repo. If you don't, ask a GitHub admin or #tech-docs-format on Slack.
-
-- Before adding your feature, [check the backlog to see if someone is already talking about it](https://github.com/alphagov/tech-docs-template/issues)
-- If you add a new option to `config/tech-docs.yml`, make sure you [document the option in docs/configuration.md](docs/configuration.md)
-- If you add a new option to the page frontmatter, make sure you [document the option in docs/frontmatter.md](docs/frontmatter.md)
-- You can test your contribution using [unit tests](spec/govuk_tech_docs), [javascript tests](spec/javascripts) or [integration tests](spec/features)
-- If your change is relevant to the users of the gem, add something to [CHANGELOG](CHANGELOG.md). You don't have to do this if it's just refactoring. Make sure that you include any upgrade instructions.
+Everybody who uses this project is encouraged to contribute to this project.

data/README.md

@@ -1,4 +1,4 @@
-# Tech Docs Template - gem
+# DSS Tech Docs Template - gem
 
 This repo contains the Ruby gem that distributes the [Tech Docs Template][tdt-template]. The Tech Docs Template is a [middleman template][mmt] that
 you can use to build technical documentation using a DSS style. This repository will age quickly as there is no attempt to keep this in sync with the published GEM. This repository was created on 25th April 2019.
@@ -27,7 +27,7 @@ There are 2 ways to develop with this gem. You can see your changes on either:
 If you want to see how your changes to the gem affect your website, you have to point your site's Gemfile to your local checkout:
 
 ```rb
-gem 'govuk_tech_docs', path: '../tech-docs-gem'
+gem 'dss_tech_docs', path: '../tech-docs-gem'
 ```
 
 To view your changes locally run:
@@ -67,9 +67,7 @@ bundle exec rake jasmine:ci
 
 ## Releasing new versions
 
-To release a new version, create a new Pull Request that updates [version.rb](lib/govuk_tech_docs/version.rb) and [CHANGELOG.md](CHANGELOG.md). Don't mix this in with other changes - this makes it easier to find out what was released when. See [this PR to release a new version as an example](https://github.com/alphagov/tech-docs-gem/pull/15).
-
-Travis will automatically release a [new version to Rubygems.org](https://rubygems.org/gems/govuk_tech_docs).
+This is a manual process for now.
 
 ## Licence
 

data/VERSION.md

@@ -0,0 +1,5 @@
+# Version
+
+## 0.1.0
+
+Initial copy from govuk_tech_docs and styling changes made for DSS.

data/dss_tech_docs.gemspec

@@ -5,7 +5,7 @@ require "govuk_tech_docs/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "dss_tech_docs"
-  spec.version       = GovukTechDocs::VERSION
+  spec.version       = "0.1.1"
   spec.authors       = ["Digital Shared Services"]
   spec.email         = ["stephen.patterson@finance-ni.gov.uk"]
 

data/lib/source/layouts/core.erb

@@ -8,6 +8,9 @@
       <meta name="robots" content="noindex">
     <% end %>
 
+    <!--  GOV.UK NTA font has been overridden to Lato, so need to load it -->
+    <link href='http://fonts.googleapis.com/css?family=Lato:400,700' rel='stylesheet' type='text/css'>
+
     <title><%= meta_tags.browser_title %></title>
 
     <!--[if gt IE 8]><!--><%= stylesheet_link_tag :screen, media: 'screen' %><!--<![endif]-->

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dss_tech_docs
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Digital Shared Services
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-05-12 00:00:00.000000000 Z
+date: 2019-06-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -310,6 +310,7 @@ files:
 - LICENCE
 - README.md
 - Rakefile
+- VERSION.md
 - docs/configuration.md
 - docs/core-layout-without-sidebar.png
 - docs/core-layout.png