govuk_tech_docs 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f5e6745794ab18eb8c628384b868c10edaecfe5a
-  data.tar.gz: 6d93cae1fd2a09c0addc299fa7b43bceecd6208f
+  metadata.gz: eaca63877550e5756571d4f83ced3aceaf75ffcd
+  data.tar.gz: 5a71ac6ab0aae9c7c543fd7636dfde0c3731a9cf
 SHA512:
-  metadata.gz: c9a3f2c71458829e25e27d0cf79cea3d19e125bafb8e3c2c28827312e2a6d6a4d28cd9b0e01aa999f051f3b0881a081d1b14dbe250e47d6d055ba48765ec1e02
-  data.tar.gz: b77c6acc475897e7423b3067abcc41f339539bd6cd5b4eb85c219fafc6a0cf8de60eec81ce55df3e7469c6a2fecedd0088261edf0c003c860f3935cd03905233
+  metadata.gz: 556dd03f8c48c4430916f3abfb5c404ccd922a2eaf7f88ebe9a50bba738c6414e4a2edac4d3773a8a58f1ff796d1d273fcc755864b0640eb6e50d902f8fab6d0
+  data.tar.gz: 393990c7b091850721339f07663e602e590a81c4582e931a8662f04ce41ee6e4437afac8ca5e6be4b6720a5822960ff6c868a7740b14890b842d0aa8b6e8651c

data/CHANGELOG.md

@@ -1,5 +1,31 @@
 # Changelog
 
+## 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

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/configuration.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/README.md

@@ -6,6 +6,10 @@ This repo is part of the [tech-docs-template](https://github.com/alphagov/tech-d
 
 To [generate a new site with the template](https://github.com/alphagov/tech-docs-template#creating-a-new-documentation-project), see the tech-docs-template repo.
 
+## Contributing
+
+👉 [See CONTRIBUTING.md](CONTRIBUTING.md)
+
 ## Developing locally
 
 There are 2 ways to develop with this gem.
@@ -19,8 +23,7 @@ gem 'govuk_tech_docs', path: '../tech-docs-gem'
 The second is to use the example app in this repo. You can start it by
 
 ```
-git clone git@github.com:alphagov/tech-docs-gem.git
-cd tech-docs-gem/example
+cd example
 bundle install
 bundle exec middleman serve
 ```
@@ -40,6 +43,14 @@ To run the tests on your machine:
 
 Or, on the command line, run `bundle exec rake jasmine:ci`.
 
+## Releasing new versions
+
+At the moment this gem has to be released manually. There's a [story on the Reliability Engineering backlog](https://trello.com/c/gRQ8OnBl) to automate this.
+
+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).
+
+[Owners of the Rubygem](https://rubygems.org/gems/govuk_tech_docs#gem__owners) can then run `rake release` to release a new version.
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](LICENSE).

data/docs/frontmatter.md

@@ -110,4 +110,14 @@ title: My beautiful page
 ---
 ```
 
+## `parent`
+
+The page that should be highlighted as ‘active’ in the navigation.
+
+```yaml
+---
+parent: shaving-yaks.html
+---
+```
+
 [mm]: https://middlemanapp.com/basics/frontmatter

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/lib/assets/stylesheets/_core.scss

@@ -34,6 +34,8 @@ $desktop-breakpoint: 992px !default;
 @import "accessibility";
 
 html, body {
+  color: $text-colour;
+  background-color: $page-colour;
   margin: 0;
   -webkit-font-smoothing: antialiased;
   -moz-osx-font-smoothing: grayscale;

data/lib/govuk_tech_docs.rb

@@ -21,7 +21,12 @@ require 'govuk_tech_docs/unique_identifier_extension'
 require 'govuk_tech_docs/unique_identifier_generator'
 
 module GovukTechDocs
-  def self.configure(context)
+  # Configure the tech docs template
+  #
+  # @param options [Hash]
+  # @option options [Hash] livereload Options to pass to the `livereload`
+  #   extension. Hash with symbols as keys.
+  def self.configure(context, options = {})
     context.activate :autoprefixer
     context.activate :sprockets
     context.activate :syntax
@@ -39,7 +44,7 @@ module GovukTechDocs
 
     # Reload the browser automatically whenever files change
     context.configure :development do
-      activate :livereload
+      activate :livereload, options[:livereload].to_h
     end
 
     context.configure :build do
@@ -65,6 +70,14 @@ module GovukTechDocs
       def format_date(date)
         date.strftime('%-e %B %Y')
       end
+
+      def active_page(page_path)
+        [
+          page_path == "/" && current_page.path == "index.html",
+          ("/" + current_page.path) == page_path,
+          current_page.data.parent != nil && current_page.data.parent.to_s == page_path,
+        ].any?
+      end
     end
 
     context.page '/*.xml', layout: false

data/lib/govuk_tech_docs/meta_tags.rb

@@ -53,7 +53,7 @@ module GovukTechDocs
     end
 
     def host
-      config[:tech_docs][:host]
+      config[:tech_docs][:host].to_s
     end
 
     def locals

data/lib/govuk_tech_docs/version.rb

@@ -1,3 +1,3 @@
 module GovukTechDocs
-  VERSION = "1.2.0".freeze
+  VERSION = "1.3.0".freeze
 end

data/lib/source/layouts/_header.erb

@@ -31,9 +31,9 @@
 
         <nav id="navigation" class="header__navigation js-nav" aria-label="Top Level Navigation" aria-hidden="true">
           <ul>
-            <% config[:tech_docs][:header_links].each do |title, url| %>
-              <li<% if url == current_page.url %> class="active"<% end %>>
-                <a href="<%= url %>">
+            <% config[:tech_docs][:header_links].each do |title, path| %>
+              <li<% if active_page(path) %> class="active"<% end %>>
+                <a href="<%= path %>">
                   <%= title %>
                 </a>
               </li>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_tech_docs
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Government Digital Service
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-04-06 00:00:00.000000000 Z
+date: 2018-05-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -249,6 +249,7 @@ files:
 - ".ruby-version"
 - ".travis.yml"
 - CHANGELOG.md
+- CONTRIBUTING.md
 - Gemfile
 - LICENSE
 - README.md
@@ -263,6 +264,7 @@ files:
 - example/Gemfile
 - example/config.rb
 - example/config/tech-docs.yml
+- example/source/child-of-expired-page.html.md
 - example/source/core-layout.html.md.erb
 - example/source/expired-page-with-owner.html.md
 - example/source/expired-page.html.md