dss_tech_docs 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 15e8faf0fa987026cd291cbf0eaa5b2b962d4856
+  data.tar.gz: 6347f8673da6972206dcdd3cc4236ff5ffa26244
+SHA512:
+  metadata.gz: 9d1b07ce838ab225aa19ec2513e9b1d8e7f01fa72427ca9ebbac8227151b3380988c074bcfef46cc235c119afbcaaf104f14baabe0756a2e614612de99bb4e5c
+  data.tar.gz: 1e3a0cb054def4f45ea8257c6c0d95bb769313f9dfcf491d431ff4f92bdb08668304cef8746b4a3df9c264efa0086b37c547597c6b59aed520a73524c99de7b3

data/.editorconfig

@@ -0,0 +1,29 @@
+# EditorConfig is awesome: http://EditorConfig.org
+# https://gds-way.cloudapps.digital/manuals/programming-languages/editorconfig
+
+# top-most EditorConfig file
+root = true
+
+[*.java]
+indent_style: space
+indent_size: 4
+end_of_line: lf
+charset: utf-8
+insert_final_newline: true
+continuation_indent_size: 8
+
+[*.{scss,erb}]
+charset = utf-8
+end_of_line = lf
+indent_style = space
+indent_size = 2
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.{js,json}]
+charset = utf-8
+end_of_line = lf
+indent_style = space
+indent_size = 2
+insert_final_newline = true
+trim_trailing_whitespace = true

data/.gitignore

@@ -0,0 +1,37 @@
+### Ruby ###
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+/example/build
+/example/.sass-cache
+
+Gemfile.lock
+
+# Ignore .DS_store file
+.DS_Store

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,11 @@
+Layout/IndentHeredoc:
+  Enabled: false
+
+Naming/HeredocDelimiterNaming:
+  Enabled: false
+
+Lint/NestedMethodDefinition:
+  Enabled: false
+
+Performance/HashEachMethods:
+  Enabled: false

data/.ruby-version

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

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+deploy:
+  provider: rubygems
+  gem: govuk_tech_docs
+  api_key:
+    secure: CY9C+IUqUeYWqXSyQgfF5swdYw1rRtYi0ai1xasD3R5rwARF6Qr8CnmdSBjfT2S84fXQiMza45Jto4w1jiy3o4wpxuKN68xEB7J4W/YEpFcZectzsmXwcMJH+DXh720KFIX2xiHaG5N0nWzAoV+6zgw6Vq24IXYE33wO6BgCmTe3vtO+Apg0+wDRAOuJ4T5XfSyWUvG8JqLRb81t+WbrsOLcUgZn24DHvs+lrjXTDDTzrgwTuKeaKd+h+mfxlHZD+Xxbcy624qop5ICwOOP0koRXCdVmTOSZ4mNI10+loCyA1B5Tryj/2wweyc8CanqRMniF8p/BxLV1sAwihpCmCpuWUyxq2pTPSgjF1A1f5hXwkAT/HiaXLzXKyO1REnbtLHYvre10EIYIII4nDAtCZP0YLYvPoKQUrAydeWiQ4jL+cyEeN/8Dznx2OPrhcwxazsElMm0yOZDNXERNIf3IVnQshxMFxQfGW3NTG8XR4l5PHAI2XqKy/O/VGbiRcNV3EYVG5w/KumB698BGDGV2QPOlh3JOEkebXTGDsMJj/gzZik2BtvAqYatwgx7oiYzvhEPz0m9o/DTS7Gf/5Hkj3iV2mpcNtRMc0HKmS7bwkv8Cl6dWECt7PWQ8Kz5ttrCKRmTCJDgra2xLFuV8kbBISPkKKv87KCXzxthM8ps94WE=
+  on:
+    repo: alphagov/tech-docs-gem
+    branch: master

data/CHANGELOG.md

@@ -0,0 +1,274 @@
+# Changelog
+
+## 1.8.2
+
+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].
+
+[expiry]: https://tdt-documentation.london.cloudapps.digital/page-expiry.html#page-expiry-and-review
+
+## 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
+```

data/CONTRIBUTING.md

@@ -0,0 +1,9 @@
+## 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.

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in govuk_tech_docs.gemspec
+gemspec

data/LICENCE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Crown Copyright (Government Digital Service)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,89 @@
+# 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.
+
+👉 Find out more about the template and its features from the [Tech Docs Template documentation][tdt-docs].
+
+## Usage
+
+👉 Find out how to [generate a new website with the Tech Docs Template][tdt-readme].
+
+## Contributing
+
+Everybody who uses this project is encouraged to contribute.
+
+👉 [See CONTRIBUTING.md](CONTRIBUTING.md) for guidance on making changes.
+
+## Developing locally
+
+There are 2 ways to develop with this gem. You can see your changes on either:
+
+- your own Tech Docs Template website
+- the example in this repository
+
+### Use your own Tech Docs Template website
+
+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'
+```
+
+To view your changes locally run:
+
+```sh
+bundle exec middleman server
+```
+
+See your website on `http://localhost:4567` in your browser.
+
+### Use the example in this repo
+
+To start the example in this repo, run:
+
+```sh
+cd example
+bundle install
+bundle exec middleman server
+```
+
+See your website on `http://localhost:4567` in your browser.
+
+## Tests
+
+The repository contains automated JavaScript tests that use [Jasmine][jas] test framework.
+
+To run the tests and see the results in your browser:
+
+1. Run `bundle exec rake jasmine`
+2. Go to `http://localhost:8888` in your browser
+
+To run the tests and see the results in your terminal, run:
+
+```
+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).
+
+## Licence
+
+Unless stated otherwise, the codebase is released under [the MIT License][mit].
+This covers both the codebase and any sample code in the documentation.
+
+The documentation is [© Crown copyright][copyright] and available under the terms of the [Open Government 3.0][ogl] licence.
+
+[mit]: LICENCE
+[copyright]: http://www.nationalarchives.gov.uk/information-management/re-using-public-sector-information/uk-government-licensing-framework/crown-copyright/
+[ogl]: http://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/
+[tdt-docs]: https://tdt-documentation.london.cloudapps.digital
+[tdt-template]: https://github.com/alphagov/tech-docs-template
+[tdt-readme]: https://github.com/alphagov/tech-docs-template/blob/master/README.md
+[mmt]: https://middlemanapp.com/advanced/project_templates/
+
+[jas]: https://jasmine.github.io/