jekyll-theme-bas-style-kit 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 89c327ba8fda0366d129d83bf7377e02520027cdf14f228d5cbb0b0526d0041c
-  data.tar.gz: 3ebf7581bb4114d223c746711e762150c6f5309ee981c21520d5869e23a50f79
+  metadata.gz: 54c4be6b3f545080f6b9a1732d0cb9ed6df145bd1e12bfd3bed99bd5d5d087f8
+  data.tar.gz: a499c53f7ce5ae7eddf776c21abf72ccad53ac450d4b8898b6051e5e3056a7dd
 SHA512:
-  metadata.gz: 11477eb8b9156a57d3f7c15f077e99bba66294d5eb62ceb0062ef1dfa5fc1d44c50071e1a608d2588ca1c4be748abcbcc2e537c6642a510b0982d843e9cdf11a
-  data.tar.gz: 48826acebfe2ad7a89895838897d368913115b7f53a1f48a2b65b6f105d5e49fb7db679ae8afcc2370e92dd9caaf5a5a2c6666feba258d65ad542197d63188a8
+  metadata.gz: 6b5fb5a4c2bff1760efb1e2add4f834d56cb2c0c558fff58b83e4ee9d99dbdfa08b10af8709cf541d2488058f085261f6d198604c0f6c0bd1d71187b94fa16fa
+  data.tar.gz: 67a8d3c47dde8f49ce089d0345da5a59cccb92cb314422c6c8ca35522af85393919493681c13e127737843490bb43f7ae3e421cadca6d580e87345aaaa3fa1e5

data/CHANGELOG.md

@@ -5,6 +5,31 @@ This project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html
 
 ## [Unreleased][unreleased]
 
+## 0.6.0 - 2018-09-18
+
+### Changed [BREAKING!]
+
+* Icon uses replaced with alternatives or removed where not needed due to the removal of Font Awesome
+* Favicon attribute option changed, set `bas_style_kit_jekyll_theme.attributes.head_favicon` to `default` for the Style 
+  Kit favicon, other values will be ignored and no favicon will be set 
+
+### Added
+
+* Updated to Style Kit 0.5.0-alpha
+* Implemented Style Kit Favicon
+* Implemented 'page not found' pattern and support for design patterns generally
+* Implemented 'Service unavailable (basic)' pattern
+
+### Changed
+
+* Updating order of navigation launcher items
+* Improving Dockerfiles
+* Improving internal test content
+
+### Fixed
+
+* Corrected link to issue tracker
+
 ## 0.5.0 - 2018-07-06
 
 ### Fixed

data/README.md

@@ -20,11 +20,11 @@ $ bundle
 
 Or install it yourself as:
 
-```
+```shell
 $ gem install jekyll-theme-bas-style-kit
 ```
 
-Add these lines to your `_config.yml` to use the Style Kit theme:
+Finally, to use the theme, add this line to your `_config.yml` file:
 
 ```yaml
 theme: jekyll-theme-bas-style-kit
@@ -34,30 +34,112 @@ theme: jekyll-theme-bas-style-kit
 
 Refer to [Jekyll's theme documentation](https://jekyllrb.com/docs/themes/) for general information.
 
-### Layouts
-
-This theme defines two types of layout:
+### Quick start
 
-* *generic* - non Style Kit specific intended for atypical content
-* *non-generic* - implement the Style Kit either broadly or in more opinionated forms
+#### Standard page
 
-All layouts use the `.html` extension. I.e. the layout `blank` should be referenced as `blank.html`.
+To base all pages on the `bsk--standard` layout, add the following to your `_config.yml` file:
 
-All layouts are namespaced using a `bas-style-kit/` directory - i.e. the layout `blank.html` should be referenced as
-`bas-style-kit/blank.html`.
+```yml
+# Content settings
+#
 
-To use a layout by default add the following to your `_config.yml`:
 
-```yml
 defaults:
   -
     scope:
-      # an empty string here means all files in the project
+      # An empty string here means all files in the project
       path: ""
     values:
       layout: "bas-style-kit/bsk--standard"
+
+
+# Theme settings
+#
+
+bas_style_kit_jekyll_theme:
+  attributes:
+    head_title:
+      default: 'Example service'
+      appended: ' - Example service'
+    head_description: 'Service to act as an example'
+    site_brand:
+        text: 'Example service'
+        href: '/'
+    site_development_phase: 'beta'
+    # Optional - web analytics
+    site_analytics:
+      id: UA-64130716-27
+    # Optional - add a custom CSS file with a relative URL
+    site_styles:
+        -
+          href: '/css/main.css'
+          type: 'local'
 ```
 
+### Patterns
+
+Design patterns are used to demonstrate preferred ways to pass on information to users, or ask them for information.
+For example, information to show when a service is unavailable, formatting dates consistently or asking users for their
+username in a consistent way. See the [Style Kit documentation](https://style-kit.web.bas.ac.uk/patterns) for more 
+information.
+
+These patterns are implemented by this theme based on the reference examples included in the Style Kit. These 
+include patterns for:
+
+* **pages** - standalone pages designed to be used without customisation, defined as [Views](#views)
+
+### Using custom CSS/JS
+
+...
+
+### Navigation menu items
+
+...
+
+### Navigation branding
+
+...
+
+### Site development phase
+
+...
+
+### Website analytics
+
+...
+
+### Views
+
+Views provide complete pages to implement page [Patterns](#patterns).
+
+All views use the `.html` extension. I.e. the view `page-not-found` should be referenced as `page-not-found.html`.
+
+All views are namespaced using a `bas-style-kit/` directory - i.e. the view `page-not-found.html` should be referenced 
+as `bas-style-kit/page-not-found.html`.
+
+Within Jekyll views are implemented as layouts. To implement a view create a page with the relevant 'view layout.
+
+```
+---
+layout: views/bas-style-kit/page-not-found
+---
+```
+
+**Note:** You do not need to add any page content.
+
+### Layouts
+
+This theme defines two types of layout:
+
+* *generic* - non Style Kit specific intended for atypical content
+* *non-generic* - implement the Style Kit either broadly or in more opinionated forms
+
+All layouts use the `.html` extension. I.e. the layout `blank` should be referenced as `blank.html`.
+
+All layouts are namespaced using a `bas-style-kit/` directory - i.e. the layout `blank.html` should be referenced as
+`bas-style-kit/blank.html`.
+
 #### Generic layouts
 
 * [`blank`](/docs/layout/blank.md)
@@ -69,6 +151,22 @@ defaults:
 * [`bsk--standard`](/docs/layout/bsk--standard.md)
 * [`bsk--standard-page`](/docs/layout/bsk--standard-page.md)
 
+**Note:** The `bsk--stardard-page` layout is only available in this theme.
+
+Layouts inheriting from the `bsk--standard` layout can add additional classes to the `#main-content` element by setting 
+the `main_content_classes` variable in each layout.
+
+For example:
+
+```
+---
+layout: bas-style-kit/bsk--standard
+main_content_classes: bsk-pattern-page-not-found
+---
+
+<h1 class="bsk-page-header">Page not found</h1>
+```
+
 ### Includes
 
 Refer to [Jekyll's documentation](https://jekyllrb.com/docs/include/) for general information.
@@ -310,18 +408,15 @@ $ docker-compose push
 [2]
 
 ```shell
-# add 'entrypoint: ash' to the app service in /docker-compose.yml
-$ docker-compose run app gem build jekyll-theme-bas-style-kit.gemspec
-$ docker-compose run app gem push jekyll-theme-bas-style-kit-*.gem
-# remove 'entrypoint: ash' from the app service in /docker-compose.yml
+$ docker-compose run --entrypoint=[] app ash
+$ gem build jekyll-theme-bas-style-kit.gemspec
+$ gem push jekyll-theme-bas-style-kit-*.gem
 ```
 
-**Note:** Add `entrypoint: ash` to the `app` service in `docker-compose.yml` to run these commands
-
 ## Issue tracking
 
-This project uses [issue tracking](https://gitlab.data.bas.ac.uk/web-apps/bsk/bas-style-kit-jekyll-theme) to manage 
-development of new features/improvements and reporting bugs.
+This project uses [issue tracking](https://trello.com/b/0Mhzizpk/bas-style-kit) to manage development of new 
+features/improvements and reporting bugs.
 
 **Note:** Read & write access to this issue tracker is restricted. Contact the project maintainer to request access.
 

data/_config.yml

@@ -60,7 +60,7 @@ bas_style_kit_jekyll_theme:
     site_scripts: []
 
     # These settings aren't usually changed
-    head_favicon: 'data:;base64,iVBORw0KGgo='
+    head_favicon: 'default'
     site_back_to_top_target_href: '#site-top'
     site_footer:
       ogl:

data/_data/bas-style-kit/bsk-css.yml

@@ -1,5 +1,5 @@
 ---
 -
-    href: 'https://cdn.web.bas.ac.uk/bas-style-kit/0.4.0/css/bas-style-kit.min.css'
-    integrity: 'sha256-ClILH8AIH4CkAybtlKhzqqQUYR4eSDiNTK5LIWfF4qQ='
+    href: 'https://cdn.web.bas.ac.uk/bas-style-kit/0.5.0-alpha/css/bas-style-kit.min.css'
+    integrity: 'sha256-nWXiUZmHWfWNh1kXmFmOIeYXTJQL0BYUcuN0lZH+YRk='
     type: 'remote'

data/_data/bas-style-kit/bsk-js.yml

@@ -8,6 +8,6 @@
     integrity: 'sha256-EareStqgZTnMUqLWtDkCa3SldvB8NPBY8u5C6ZUMWRc='
     type: 'remote'
 -
-    href: 'https://cdn.web.bas.ac.uk/bas-style-kit/0.4.0/js/bas-style-kit.min.js'
-    integrity: 'sha256-buOvInyhMJKHpUjqgaYtulG026RRSemvLNsl3xfXsGQ='
+    href: 'https://cdn.web.bas.ac.uk/bas-style-kit/0.5.0-alpha/js/bas-style-kit.min.js'
+    integrity: 'sha256-hWgpo+9I3Nv3OcGXddejrZZNUNEzKBxaoxO/4IYImoM='
     type: 'remote'

data/_data/bas-style-kit/bsk-vars.yml

@@ -1,3 +1,3 @@
 ---
-theme_version: "0.5.0"
-bsk_version: "0.4.0"
+theme_version: "0.6.0"
+bsk_version: "0.5.0-alpha"

data/_data/menus.yml

@@ -16,4 +16,4 @@ site_navigation_launcher:
     weight: 1
   - url: 'https://data.bas.ac.uk'
     title: Discover BAS Data
-    weight: 100
+    weight: 2

data/_includes/bas-style-kit/bsk-body--standard.html

@@ -5,7 +5,7 @@
     {% if site.bas_style_kit_jekyll_theme.feature_flags.site.standard_header == true %}
         {% include bas-style-kit/bsk-body--standard-header.html %}
     {% endif %}
-    <main class="{% if site.bas_style_kit_jekyll_theme.attributes.container == 'fixed' %}bsk-container{% elsif site.bas_style_kit_jekyll_theme.attributes.container == 'fluid' %}bsk-container-fluid{% endif %}" id="site-content">
+    <main class="{% if site.bas_style_kit_jekyll_theme.attributes.container == 'fixed' %}bsk-container{% elsif site.bas_style_kit_jekyll_theme.attributes.container == 'fluid' %}bsk-container-fluid{% endif %} {{ layout.main_content_classes }}" id="site-content">
         {{ content }}
     </main>
     {% if site.bas_style_kit_jekyll_theme.feature_flags.site.standard_footer == true %}

data/_includes/bas-style-kit/bsk-footer--back-to-top.html

@@ -1,5 +1,3 @@
 <div class="bsk-footer-back-to-top">
-    <a href="{{ site.bas_style_kit_jekyll_theme.attributes.site_back_to_top_target_href }}">
-        <i class="fa fa-fw fa-chevron-up" aria-hidden="true"></i> Back to top
-    </a>
+    <a href="{{ site.bas_style_kit_jekyll_theme.attributes.site_back_to_top_target_href }}"> Back to top</a>
 </div>

data/_includes/bas-style-kit/bsk-head--favicon.html

@@ -1,2 +1,12 @@
 <!-- Favicon and app icons -->
-{% if site.bas_style_kit_jekyll_theme.attributes.head_favicon %}<link rel="icon" href="{{ site.bas_style_kit_jekyll_theme.attributes.head_favicon }}">{% endif %}
+{% if site.bas_style_kit_jekyll_theme.attributes.head_favicon == 'default' %}
+  <link rel="apple-touch-icon" sizes="180x180" href="https://cdn.web.bas.ac.uk/bas-style-kit/{{ site.data.bas-style-kit.bsk-vars.bsk_version }}/img/favicon/apple-touch-icon.png">
+  <link rel="icon" type="image/png" sizes="32x32" href="https://cdn.web.bas.ac.uk/bas-style-kit/{{ site.data.bas-style-kit.bsk-vars.bsk_version }}/img/favicon/favicon-32x32.png">
+  <link rel="icon" type="image/png" sizes="16x16" href="https://cdn.web.bas.ac.uk/bas-style-kit/{{ site.data.bas-style-kit.bsk-vars.bsk_version }}/img/favicon/favicon-16x16.png">
+  <link rel="manifest" href="https://cdn.web.bas.ac.uk/bas-style-kit/{{ site.data.bas-style-kit.bsk-vars.bsk_version }}/img/favicon/site.webmanifest">
+  <link rel="mask-icon" href="https://cdn.web.bas.ac.uk/bas-style-kit/{{ site.data.bas-style-kit.bsk-vars.bsk_version }}/img/favicon/safari-pinned-tab.svg" color="#222222">
+  <link rel="shortcut icon" href="https://cdn.web.bas.ac.uk/bas-style-kit/{{ site.data.bas-style-kit.bsk-vars.bsk_version }}/img/favicon/favicon.ico">
+  <meta "name"="msapplication-TileColor" content="#222222">
+  <meta "name"="msapplication-config" content="https://cdn.web.bas.ac.uk/bas-style-kit/{{ site.data.bas-style-kit.bsk-vars.bsk_version }}/img/favicon/browserconfig.xml">
+  <meta "name"="theme-color" content="#222222">
+{% endif %}

data/_includes/bas-style-kit/bsk-header--cookie-notice.html

@@ -1,9 +1,7 @@
 <div class="bsk-fix-alert-static-top-{{ site.bas_style_kit_jekyll_theme.attributes.container }}-container-wrapper">
     <div class="{{ bsk_attributes_container_class }}">
         <div class="bsk-alert bsk-alert-static-top bsk-alert-dismissible bsk-alert-solid bsk-alert-cookie-notice" data-bsk-role='cookie-notice'>
-            <button class="bsk-close" type="button" data-dismiss="alert" aria-label="Close">
-                <i class="fa fa-times" aria-hidden="true"></i>
-            </button>
+            <button class="bsk-close" type="button" data-dismiss="alert" aria-label="Close">&times;</button>
             This website uses cookies to help us make it better - 
             <a class="bsk-alert-link" href="{{ site.bas_style_kit_jekyll_theme.attributes.site_footer.legal_policies.cookies_href }}">find out more</a>
         </div>

data/_layouts/views/bas-style-kit/bsk--page-not-found.html

@@ -0,0 +1,10 @@
+---
+layout: bas-style-kit/bsk--standard
+main_content_classes: bsk-pattern-page-not-found
+title: Page not found
+---
+
+<h1 class="bsk-page-header">Page not found</h1>
+<p>If you typed the web address, check it is correct.</p>
+<p>If you pasted the web address, check you copied the entire address.</p>
+<p>If the web address is correct or you selected a link or button, <a href="{{ site.bas_style_kit_jekyll_theme.attributes.site_feedback_href }}">contact us</a> to let us know.</p>

data/_layouts/views/bas-style-kit/bsk--service-unavailable-basic.html

@@ -0,0 +1,8 @@
+---
+layout: bas-style-kit/bsk--standard
+main_content_classes: bsk-pattern-service-unavailable
+title: Service unavailable
+---
+
+<h1 class="bsk-page-header">Service unavailable</h1>
+<p class="bsk-lead">You will be able to use the service later</p>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-theme-bas-style-kit
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Felix Fennell
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-06 00:00:00.000000000 Z
+date: 2018-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -170,6 +170,8 @@ files:
 - _layouts/bas-style-kit/bsk--standard-page.html
 - _layouts/bas-style-kit/bsk--standard.html
 - _layouts/bas-style-kit/html.html
+- _layouts/views/bas-style-kit/bsk--page-not-found.html
+- _layouts/views/bas-style-kit/bsk--service-unavailable-basic.html
 - _sass/main.scss
 - assets/empty
 - screenshot.png