jekyll-theme-bas-style-kit 0.6.0 → 0.7.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +26 -0
- data/README.md +52 -9
- data/_data/bas-style-kit/bsk-css.yml +2 -2
- data/_data/bas-style-kit/bsk-js.yml +2 -2
- data/_data/bas-style-kit/bsk-vars.yml +2 -2
- data/_layouts/views/bas-style-kit/bsk--problem-with-service.html +10 -0
- data/_layouts/views/bas-style-kit/bsk--service-unavailable.html +20 -0
- data/screenshot.png +0 -0
- metadata +6 -5
- data/_layouts/views/bas-style-kit/bsk--service-unavailable-basic.html +0 -8
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 3905484aaab5b75365199d0b9a17442652f2a67f9f06b96e33555d6d8fe0233b
|
4
|
+
data.tar.gz: dac3c03bfcaa3bbcd00f7dc7654475a12224b189c4e7ac973897d3e688d01cce
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: d0744c66e5db1712a59bf9ce43164eac99b5cbba8b1309013b8ee2c88bf2524a740fef4252dc4d1692a115ba0c19aa910dc1d4918850b152849d62ccb0f5ae66
|
7
|
+
data.tar.gz: b3a9f999182330414b1fd6d054dad63b020839c0650bd71c5220237a46fd6ed2729004a84a8b41e20fabbe8591460173015ebddfae67648c95bb3a97eaff1d75
|
data/CHANGELOG.md
CHANGED
@@ -5,6 +5,31 @@ This project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html
|
|
5
5
|
|
6
6
|
## [Unreleased][unreleased]
|
7
7
|
|
8
|
+
## 0.7.0 - 2018-11-24
|
9
|
+
|
10
|
+
### Added
|
11
|
+
|
12
|
+
* 'Problem with this service' (basic) page pattern variant
|
13
|
+
* 'Problem with this service' (contact) page pattern variant
|
14
|
+
* 'Problem with this service' (alternative) page pattern variant
|
15
|
+
* 'Service unavailable' (contact) page pattern variant
|
16
|
+
* 'Service unavailable' (availability) page pattern variant
|
17
|
+
* 'Service unavailable' (alternative) page pattern variant
|
18
|
+
* 'Service unavailable' (partly closed) page pattern variant
|
19
|
+
* 'Service unavailable' (closed) page pattern variant
|
20
|
+
* 'Service unavailable' (replaced) page pattern variant
|
21
|
+
* Updated to Jekyll 3.8.5 to address security vulnerability
|
22
|
+
* Updated to Style Kit 0.5.0-beta
|
23
|
+
* Snyk dependency scanning support
|
24
|
+
|
25
|
+
### Fixed
|
26
|
+
|
27
|
+
* README typo
|
28
|
+
|
29
|
+
### Changed
|
30
|
+
|
31
|
+
* Improving release procedures
|
32
|
+
|
8
33
|
## 0.6.0 - 2018-09-18
|
9
34
|
|
10
35
|
### Changed [BREAKING!]
|
@@ -19,6 +44,7 @@ This project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html
|
|
19
44
|
* Implemented Style Kit Favicon
|
20
45
|
* Implemented 'page not found' pattern and support for design patterns generally
|
21
46
|
* Implemented 'Service unavailable (basic)' pattern
|
47
|
+
* Ruby dependencies are now scanned for vulnerabilities using Snyk
|
22
48
|
|
23
49
|
### Changed
|
24
50
|
|
data/README.md
CHANGED
@@ -1,6 +1,6 @@
|
|
1
1
|
# BAS Style Kit Jekyll Theme
|
2
2
|
|
3
|
-
Jekyll theme for the [BAS Style Kit](https://
|
3
|
+
Jekyll theme for the [BAS Style Kit](https://style-kit.web.bas.ac.uk).
|
4
4
|
|
5
5
|
![Screenshot of theme](screenshot.png)
|
6
6
|
|
@@ -84,10 +84,38 @@ For example, information to show when a service is unavailable, formatting dates
|
|
84
84
|
username in a consistent way. See the [Style Kit documentation](https://style-kit.web.bas.ac.uk/patterns) for more
|
85
85
|
information.
|
86
86
|
|
87
|
-
These patterns are implemented by this theme based on the reference examples included in the Style Kit.
|
88
|
-
include patterns for:
|
87
|
+
These patterns are implemented by this theme based on the reference examples included in the Style Kit.
|
89
88
|
|
90
|
-
|
89
|
+
#### Page patterns
|
90
|
+
|
91
|
+
These template include [Views](#views) for all page patterns. In most cases all variants of a pattern use the same view,
|
92
|
+
but with different options using variables and/or page content.
|
93
|
+
|
94
|
+
See the [Style Kit documentation](https://style-kit.web.bas.ac.uk) for general information on using these patterns.
|
95
|
+
|
96
|
+
##### 'page not found' pattern
|
97
|
+
|
98
|
+
No configuration options.
|
99
|
+
|
100
|
+
##### 'service unavailable' pattern
|
101
|
+
|
102
|
+
Optionally, use page content for:
|
103
|
+
|
104
|
+
* contact information
|
105
|
+
* details of alternative services
|
106
|
+
|
107
|
+
Optionally, use a `pattern_availability` page variable for setting the availability line:
|
108
|
+
|
109
|
+
* a value of `closed` will show conventional text
|
110
|
+
* a value of `replaced` will show conventional text
|
111
|
+
* no value will show conventional text
|
112
|
+
|
113
|
+
##### 'problem with this service' pattern
|
114
|
+
|
115
|
+
Optionally, use page content for:
|
116
|
+
|
117
|
+
* contact information
|
118
|
+
* details of alternative services
|
91
119
|
|
92
120
|
### Using custom CSS/JS
|
93
121
|
|
@@ -118,7 +146,7 @@ All views use the `.html` extension. I.e. the view `page-not-found` should be re
|
|
118
146
|
All views are namespaced using a `bas-style-kit/` directory - i.e. the view `page-not-found.html` should be referenced
|
119
147
|
as `bas-style-kit/page-not-found.html`.
|
120
148
|
|
121
|
-
Within Jekyll views are implemented as layouts. To
|
149
|
+
Within Jekyll, views are implemented as layouts. To use a view, create a page with the relevant 'view' layout.
|
122
150
|
|
123
151
|
```
|
124
152
|
---
|
@@ -126,7 +154,8 @@ layout: views/bas-style-kit/page-not-found
|
|
126
154
|
---
|
127
155
|
```
|
128
156
|
|
129
|
-
|
157
|
+
Views for some pattern variants can be used as-is, others require variables or page content to be set as well. See the
|
158
|
+
[Page patterns](#page-patterns) section for more information.
|
130
159
|
|
131
160
|
### Layouts
|
132
161
|
|
@@ -344,6 +373,14 @@ $ docker-compose push app
|
|
344
373
|
$ docker login docker-registry.data.bas.ac.uk
|
345
374
|
```
|
346
375
|
|
376
|
+
#### Dependency vulnerability scanning
|
377
|
+
|
378
|
+
To ensure the security of this project, and users of the Style Kit, all dependencies are checked against
|
379
|
+
[Snyk](https://app.snyk.io/org/antarctica/project/a409ca29-86a3-45de-9838-5f1d7d1aca12) for vulnerabilities.
|
380
|
+
|
381
|
+
Through [Continuous Integration](#continuous-integration), on each commit current dependencies are tested and a
|
382
|
+
snapshot uploaded to Snyk. This snapshot is then monitored for vulnerabilities.
|
383
|
+
|
347
384
|
### Jekyll plugins
|
348
385
|
|
349
386
|
Additional Jekyll plugins (gems) can be used by listing them as dependencies in the `gems` option in `_config.yml`.
|
@@ -364,6 +401,12 @@ The `jekyll-theme-bas-style-kit.gemspec` file details the properties of the Gem
|
|
364
401
|
**Note:** The `spec.files` parameter controls which files in this project are copied into the Gem. If a file is not
|
365
402
|
listed it won't be included. This is separate to the Git `.gitignore` file.
|
366
403
|
|
404
|
+
## Testing
|
405
|
+
|
406
|
+
### Continuous Integration
|
407
|
+
|
408
|
+
The BAS GitLab instance is used for Continuous Integration using settings defined in `.gitlab-ci.yml`.
|
409
|
+
|
367
410
|
## GitHub mirror
|
368
411
|
|
369
412
|
A read-only mirror of this project's repository is maintained on GitHub, to support Jekyll's automatic theme
|
@@ -377,10 +420,11 @@ Before release:
|
|
377
420
|
|
378
421
|
1. create a release branch
|
379
422
|
2. remove `-develop` from the version in:
|
423
|
+
* `.gitlab-ci.yml`
|
380
424
|
* `jekyll-theme-bas-style-kit.gemspec`
|
381
425
|
* `docker-compose.yml`
|
382
426
|
* `_data/bsk_jekyll_vars.json`
|
383
|
-
3. push the app docker image [1]
|
427
|
+
3. build and push the app docker image [1]
|
384
428
|
4. if new config options have been set, update the usage section
|
385
429
|
5. update screen-shot (width: 900px)
|
386
430
|
6. close release in changelog
|
@@ -392,6 +436,7 @@ Before release:
|
|
392
436
|
After release:
|
393
437
|
|
394
438
|
1. bump the version with `-develop` as a prefix in:
|
439
|
+
* `.gitlab-ci.yml`
|
395
440
|
* `jekyll-theme-bas-style-kit.gemspec`
|
396
441
|
* `docker-compose.yml`
|
397
442
|
* `_data/bsk_jekyll_vars.json`
|
@@ -418,8 +463,6 @@ $ gem push jekyll-theme-bas-style-kit-*.gem
|
|
418
463
|
This project uses [issue tracking](https://trello.com/b/0Mhzizpk/bas-style-kit) to manage development of new
|
419
464
|
features/improvements and reporting bugs.
|
420
465
|
|
421
|
-
**Note:** Read & write access to this issue tracker is restricted. Contact the project maintainer to request access.
|
422
|
-
|
423
466
|
## Feedback
|
424
467
|
|
425
468
|
The maintainer of this project is the BAS Web & Applications Team, they can be contacted through the
|
@@ -1,5 +1,5 @@
|
|
1
1
|
---
|
2
2
|
-
|
3
|
-
href: 'https://cdn.web.bas.ac.uk/bas-style-kit/0.5.0-
|
4
|
-
integrity: 'sha256-
|
3
|
+
href: 'https://cdn.web.bas.ac.uk/bas-style-kit/0.5.0-beta/css/bas-style-kit.min.css'
|
4
|
+
integrity: 'sha256-7W+t8HHEKqkGFLCdHj4Fvaz6JAY6hB8T6B0ElpoepIU='
|
5
5
|
type: 'remote'
|
@@ -8,6 +8,6 @@
|
|
8
8
|
integrity: 'sha256-EareStqgZTnMUqLWtDkCa3SldvB8NPBY8u5C6ZUMWRc='
|
9
9
|
type: 'remote'
|
10
10
|
-
|
11
|
-
href: 'https://cdn.web.bas.ac.uk/bas-style-kit/0.5.0-
|
12
|
-
integrity: 'sha256-
|
11
|
+
href: 'https://cdn.web.bas.ac.uk/bas-style-kit/0.5.0-beta/js/bas-style-kit.min.js'
|
12
|
+
integrity: 'sha256-zqDnDK69Sm44Abb2ZWqiZ4uqrVFTQRajeflPB9lzGFE='
|
13
13
|
type: 'remote'
|
@@ -1,3 +1,3 @@
|
|
1
1
|
---
|
2
|
-
theme_version: "0.
|
3
|
-
bsk_version: "0.5.0-
|
2
|
+
theme_version: "0.7.0"
|
3
|
+
bsk_version: "0.5.0-beta"
|
@@ -0,0 +1,10 @@
|
|
1
|
+
---
|
2
|
+
layout: bas-style-kit/bsk--standard
|
3
|
+
main_content_classes: bsk-pattern-problem-with-service
|
4
|
+
title: Service unavailable
|
5
|
+
---
|
6
|
+
|
7
|
+
<h1 class="bsk-page-header">Sorry, there is a problem with this service</h1>
|
8
|
+
<p class="bsk-lead">Please try again later.</p>
|
9
|
+
|
10
|
+
{{ content }}
|
@@ -0,0 +1,20 @@
|
|
1
|
+
---
|
2
|
+
layout: bas-style-kit/bsk--standard
|
3
|
+
main_content_classes: bsk-pattern-service-unavailable
|
4
|
+
title: Service unavailable
|
5
|
+
---
|
6
|
+
|
7
|
+
<h1 class="bsk-page-header">Sorry, {{ site.bas_style_kit_jekyll_theme.attributes.site_brand.text }} is unavailable</h1>
|
8
|
+
{% if page.pattern_availability %}
|
9
|
+
{% if page.pattern_availability == 'closed' %}
|
10
|
+
<p class="bsk-lead">This service has been {{ page.pattern_availability }} and can no longer be used.</p>
|
11
|
+
{% elsif page.pattern_availability == 'replaced' %}
|
12
|
+
<p class="bsk-lead">This service has been {{ page.pattern_availability }} and can no longer be used.</p>
|
13
|
+
{% else %}
|
14
|
+
<p class="bsk-lead">{{ page.pattern_availability }}</p>
|
15
|
+
{% endif %}
|
16
|
+
{% else %}
|
17
|
+
<p class="bsk-lead">You will be able to use the service later.</p>
|
18
|
+
{% endif %}
|
19
|
+
|
20
|
+
{{ content }}
|
data/screenshot.png
CHANGED
Binary file
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: jekyll-theme-bas-style-kit
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.
|
4
|
+
version: 0.7.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Felix Fennell
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2018-
|
11
|
+
date: 2018-11-24 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: jekyll
|
@@ -19,7 +19,7 @@ dependencies:
|
|
19
19
|
version: '3.8'
|
20
20
|
- - ">="
|
21
21
|
- !ruby/object:Gem::Version
|
22
|
-
version: 3.8.
|
22
|
+
version: 3.8.5
|
23
23
|
type: :runtime
|
24
24
|
prerelease: false
|
25
25
|
version_requirements: !ruby/object:Gem::Requirement
|
@@ -29,7 +29,7 @@ dependencies:
|
|
29
29
|
version: '3.8'
|
30
30
|
- - ">="
|
31
31
|
- !ruby/object:Gem::Version
|
32
|
-
version: 3.8.
|
32
|
+
version: 3.8.5
|
33
33
|
- !ruby/object:Gem::Dependency
|
34
34
|
name: jekyll-data
|
35
35
|
requirement: !ruby/object:Gem::Requirement
|
@@ -171,7 +171,8 @@ files:
|
|
171
171
|
- _layouts/bas-style-kit/bsk--standard.html
|
172
172
|
- _layouts/bas-style-kit/html.html
|
173
173
|
- _layouts/views/bas-style-kit/bsk--page-not-found.html
|
174
|
-
- _layouts/views/bas-style-kit/bsk--
|
174
|
+
- _layouts/views/bas-style-kit/bsk--problem-with-service.html
|
175
|
+
- _layouts/views/bas-style-kit/bsk--service-unavailable.html
|
175
176
|
- _sass/main.scss
|
176
177
|
- assets/empty
|
177
178
|
- screenshot.png
|