dss_tech_docs 0.1.0 → 0.1.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +4 -269
- data/CONTRIBUTING.md +1 -7
- data/README.md +3 -5
- data/VERSION.md +5 -0
- data/dss_tech_docs.gemspec +1 -1
- data/lib/source/layouts/core.erb +3 -0
- metadata +3 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: d1d8d54f8191a15f8d4d0405d22390cfe69fb8db
|
4
|
+
data.tar.gz: 51656918318c8e4cd56e14232a92e6716f52844f
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 9f8beb1dbf8b9059c1ca590f27536a7912701e8f600492c666497e24421ad6c7392c3ce4a8b9196b834673480b18932b3b7ba42fc03c4da16059f79e116edbf5
|
7
|
+
data.tar.gz: b1d4fc6ce585bd6f1aa9eb915be24ca539873ca725a222016be1e8128524383832c2ddd23687d9aafe409191b18075755c9941fb14d549f206c1e337fbc6d28d
|
data/CHANGELOG.md
CHANGED
@@ -1,274 +1,9 @@
|
|
1
1
|
# Changelog
|
2
2
|
|
3
|
-
## 1.
|
3
|
+
## 0.1.0
|
4
4
|
|
5
|
-
|
5
|
+
Initial copy from govuk_tech_docs and styling changes made for DSS.
|
6
6
|
|
7
|
-
|
7
|
+
## 0.1.1
|
8
8
|
|
9
|
-
|
10
|
-
|
11
|
-
This release fixes a bug (#79 - reported in
|
12
|
-
[alphagov/tech-docs-template#183][tdt-183]) which prevented a multipage site
|
13
|
-
from being generated when a custom `http_prefix` was configured.
|
14
|
-
|
15
|
-
[tdt-183]: https://github.com/alphagov/tech-docs-template/issues/183
|
16
|
-
|
17
|
-
## 1.8.0
|
18
|
-
|
19
|
-
🎉 Our first contributor from outside of GDS. Thanks [@timja](https://github.com/timja) from [HMCTS](https://hmcts.github.io)! 🤝
|
20
|
-
|
21
|
-
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).
|
22
|
-
|
23
|
-
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)).
|
24
|
-
|
25
|
-
## 1.7.0
|
26
|
-
|
27
|
-
New features: this release adds support for a full-width page (#63) and adding HTML to the `head` of the page (#64).
|
28
|
-
|
29
|
-
This release also makes sure that all pages are returned in the `/api/pages.json` endpoint (#66).
|
30
|
-
|
31
|
-
## 1.6.3
|
32
|
-
|
33
|
-
The gem now uses `middleman-search-gds` rather than `middleman-search`, which
|
34
|
-
removes the need for projects to point to the alphagov github repository in
|
35
|
-
their Gemfiles. We will continue to maintain our own fork until the changes
|
36
|
-
are merged into the upstream project.
|
37
|
-
|
38
|
-
## 1.6.2
|
39
|
-
|
40
|
-
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).
|
41
|
-
|
42
|
-
## 1.6.1
|
43
|
-
|
44
|
-
### Make `api_path` configuration optional
|
45
|
-
|
46
|
-
A bug in the previous release prevented the docs from being generated if
|
47
|
-
`api_path` was missing. This is now fixed.
|
48
|
-
|
49
|
-
## 1.6.0
|
50
|
-
|
51
|
-
Version 1.6.0 adds API reference generation, and improves the search function.
|
52
|
-
|
53
|
-
### New feature: API reference
|
54
|
-
|
55
|
-
Specify an OpenAPI spec file using `api_path`, for example: `api_path: source/pets.yml`.
|
56
|
-
|
57
|
-
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`
|
58
|
-
|
59
|
-
This generates request and response schemas and examples for each API operation.
|
60
|
-
|
61
|
-
More info:
|
62
|
-
|
63
|
-
- https://github.com/alphagov/tech-docs-gem/pull/40
|
64
|
-
- https://github.com/alphagov/tech-docs-gem/pull/48
|
65
|
-
|
66
|
-
### Search result improvements
|
67
|
-
|
68
|
-
The search indexing pipeline has been tweaked to provide expected results. The display of the search results has also been
|
69
|
-
|
70
|
-
If you're using search then you'll need to add this line to your project `Gemfile`:
|
71
|
-
|
72
|
-
```
|
73
|
-
gem 'middleman-search', git: 'git://github.com/alphagov/middleman-search.git'
|
74
|
-
```
|
75
|
-
|
76
|
-
More info:
|
77
|
-
- https://github.com/alphagov/tech-docs-gem/pull/37
|
78
|
-
- https://github.com/alphagov/tech-docs-gem/pull/38
|
79
|
-
- https://github.com/alphagov/tech-docs-gem/pull/41
|
80
|
-
- https://github.com/alphagov/tech-docs-gem/pull/42
|
81
|
-
- https://github.com/alphagov/tech-docs-gem/pull/43
|
82
|
-
|
83
|
-
### Correct fork of middleman in example project
|
84
|
-
|
85
|
-
The example gem project now uses alphagov/middleman-search. This prevents `bundle exec middleman serve` from crashing.
|
86
|
-
|
87
|
-
More info:
|
88
|
-
- https://github.com/alphagov/tech-docs-gem/pull/35
|
89
|
-
|
90
|
-
### Accessibility improvements
|
91
|
-
|
92
|
-
Accessibility improvements to search, collapsible navigation, and the logo.
|
93
|
-
|
94
|
-
More info:
|
95
|
-
- https://github.com/alphagov/tech-docs-gem/pull/36
|
96
|
-
- https://github.com/alphagov/tech-docs-gem/pull/33
|
97
|
-
|
98
|
-
### Additional configuration options for review system
|
99
|
-
|
100
|
-
`default_owner_slack` and `owner_slack_workspace` are now configurable for use within the review system.
|
101
|
-
|
102
|
-
More info:
|
103
|
-
- https://github.com/alphagov/tech-docs-gem/pull/47
|
104
|
-
|
105
|
-
### Correct fork of middleman in example project
|
106
|
-
|
107
|
-
The example gem project now uses alphagov/middleman-search. This prevents `bundle exec middleman serve` from crashing.
|
108
|
-
|
109
|
-
More info:
|
110
|
-
- https://github.com/alphagov/tech-docs-gem/pull/35
|
111
|
-
|
112
|
-
### Accessibility improvements
|
113
|
-
|
114
|
-
Accessibility improvements to search, collapsible navigation, and the logo.
|
115
|
-
|
116
|
-
More info:
|
117
|
-
- https://github.com/alphagov/tech-docs-gem/pull/36
|
118
|
-
- https://github.com/alphagov/tech-docs-gem/pull/33
|
119
|
-
|
120
|
-
### Search result improvements
|
121
|
-
|
122
|
-
The search indexing pipeline has been tweaked to provide expected results. The display of the search results has also been improved.
|
123
|
-
|
124
|
-
If you're using search then you'll need to add this line to your project `Gemfile`:
|
125
|
-
|
126
|
-
```
|
127
|
-
gem 'middleman-search', git: 'git://github.com/alphagov/middleman-search.git'
|
128
|
-
```
|
129
|
-
|
130
|
-
More info:
|
131
|
-
- https://github.com/alphagov/tech-docs-gem/pull/37
|
132
|
-
- https://github.com/alphagov/tech-docs-gem/pull/38
|
133
|
-
- https://github.com/alphagov/tech-docs-gem/pull/41
|
134
|
-
- https://github.com/alphagov/tech-docs-gem/pull/42
|
135
|
-
- https://github.com/alphagov/tech-docs-gem/pull/43
|
136
|
-
|
137
|
-
## 1.5.0
|
138
|
-
|
139
|
-
### New feature: Search
|
140
|
-
|
141
|
-
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.
|
142
|
-
|
143
|
-
More info:
|
144
|
-
- https://github.com/alphagov/tech-docs-gem/pull/28
|
145
|
-
|
146
|
-
### Google Analytics tracking for old headings
|
147
|
-
|
148
|
-
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.
|
149
|
-
|
150
|
-
More info:
|
151
|
-
- https://github.com/alphagov/tech-docs-gem/pull/30
|
152
|
-
|
153
|
-
## 1.4.0
|
154
|
-
|
155
|
-
Adds multiple page navigation support and collapsible top level navigation
|
156
|
-
items. When enabled the table of contents will display other pages on the site.
|
157
|
-
|
158
|
-
More info:
|
159
|
-
- https://github.com/alphagov/tech-docs-gem/pull/27
|
160
|
-
|
161
|
-
## 1.3.1
|
162
|
-
|
163
|
-
Minor update to Google Analytics tracking
|
164
|
-
|
165
|
-
More info:
|
166
|
-
- https://github.com/alphagov/tech-docs-gem/pull/25
|
167
|
-
|
168
|
-
## 1.3.0
|
169
|
-
|
170
|
-
Version 1.3.0 contains accessibility fixes (#20) and a fix to make the
|
171
|
-
site more robust when certain options aren't set in the configs (#17).
|
172
|
-
|
173
|
-
### New feature: passing options to `GovukTechDocs.configure`
|
174
|
-
|
175
|
-
You can now pass options into `GovukTechDocs.configure` for the `livereload`
|
176
|
-
extension.
|
177
|
-
|
178
|
-
```rb
|
179
|
-
GovukTechDocs.configure(self, livereload: { js_host: 'localhost' })
|
180
|
-
```
|
181
|
-
|
182
|
-
See PR #18.
|
183
|
-
|
184
|
-
### New feature: page parents
|
185
|
-
|
186
|
-
You can now specify a page’s parent in its frontmatter. This affects
|
187
|
-
which item is selected in the navigation.
|
188
|
-
|
189
|
-
More info:
|
190
|
-
|
191
|
-
- https://github.com/alphagov/tech-docs-gem/pull/19
|
192
|
-
- https://github.com/alphagov/tech-docs-gem/blob/master/docs/frontmatter.md#parent
|
193
|
-
|
194
|
-
## 1.2.0
|
195
|
-
|
196
|
-
### New feature: redirects
|
197
|
-
|
198
|
-
You can now specify redirects in the frontmatter and `config/tech-docs.yml`.
|
199
|
-
|
200
|
-
You can use this when you change a page URL.
|
201
|
-
|
202
|
-
More info:
|
203
|
-
|
204
|
-
- https://github.com/alphagov/tech-docs-gem/blob/master/docs/configuration.md#redirects
|
205
|
-
- https://github.com/alphagov/tech-docs-gem/blob/master/docs/frontmatter.md#old_paths
|
206
|
-
|
207
|
-
### New feature: contribution banner
|
208
|
-
|
209
|
-
You can now show a block at the bottom of the page that links to
|
210
|
-
the page source on GitHub, so readers can easily contribute back to the documentation.
|
211
|
-
|
212
|
-
https://github.com/alphagov/tech-docs-gem/blob/master/docs/configuration.md#show_contribution_banner
|
213
|
-
|
214
|
-
### New feature: page review system
|
215
|
-
|
216
|
-
An optional page review system to make sure documentation stays up to date.
|
217
|
-
|
218
|
-
More info:
|
219
|
-
|
220
|
-
- https://github.com/alphagov/tech-docs-gem/blob/master/docs/frontmatter.md#last_reviewed_on
|
221
|
-
- https://github.com/alphagov/tech-docs-gem/blob/master/docs/frontmatter.md#owner_slack
|
222
|
-
|
223
|
-
|
224
|
-
### Better meta tags
|
225
|
-
|
226
|
-
Pages now include better meta tags for search engines, Twitter, Facebook and Slack to pick up.
|
227
|
-
|
228
|
-
## 1.1.0
|
229
|
-
|
230
|
-
You can now specify `google_site_verification` in tech-docs.yml. You can use
|
231
|
-
this to verify your site in Google Webmaster tools.
|
232
|
-
|
233
|
-
https://github.com/alphagov/tech-docs-gem/blob/master/docs/configuration.md#google_site_verification
|
234
|
-
|
235
|
-
## 1.0.0
|
236
|
-
|
237
|
-
The first release of the template as a gem. Most CSS, JS, images and layouts are
|
238
|
-
now imported from the gem and can be removed from your project.
|
239
|
-
|
240
|
-
The following script upgrades your project. This will work if you've not made
|
241
|
-
any modifications to the files distributed by the template. If you have, you'll
|
242
|
-
need to port your changes back in.
|
243
|
-
|
244
|
-
```sh
|
245
|
-
rm -rf lib source/images source/layouts source/favicon.ico source/javascripts/* source/stylesheets/*
|
246
|
-
|
247
|
-
echo "//= require govuk_tech_docs" > source/javascripts/application.js
|
248
|
-
echo "@import 'govuk_tech_docs';" > source/stylesheets/screen.css.scss
|
249
|
-
|
250
|
-
echo '$is-print: true;
|
251
|
-
|
252
|
-
@import "govuk_tech_docs";' > source/stylesheets/print.css.scss
|
253
|
-
|
254
|
-
echo '$is-ie: true;
|
255
|
-
$ie-version: 8;
|
256
|
-
|
257
|
-
@import "govuk_tech_docs";' > source/stylesheets/screen-old-ie.css.scss
|
258
|
-
|
259
|
-
echo "require 'govuk_tech_docs'
|
260
|
-
|
261
|
-
GovukTechDocs.configure(self)" > config.rb
|
262
|
-
|
263
|
-
echo "source 'https://rubygems.org'
|
264
|
-
|
265
|
-
# For faster file watcher updates on Windows:
|
266
|
-
gem 'wdm', '~> 0.1.0', platforms: [:mswin, :mingw]
|
267
|
-
|
268
|
-
# Windows does not come with time zone data
|
269
|
-
gem 'tzinfo-data', platforms: [:mswin, :mingw, :jruby]
|
270
|
-
|
271
|
-
gem 'govuk_tech_docs'" > Gemfile
|
272
|
-
|
273
|
-
bundle install
|
274
|
-
```
|
9
|
+
Include the Lato font in the header as the GOV.UK NTA font has been overridden
|
data/CONTRIBUTING.md
CHANGED
@@ -1,9 +1,3 @@
|
|
1
1
|
## Contributing to this project
|
2
2
|
|
3
|
-
Everybody who uses this project is encouraged to contribute to this project.
|
4
|
-
|
5
|
-
- Before adding your feature, [check the backlog to see if someone is already talking about it](https://github.com/alphagov/tech-docs-template/issues)
|
6
|
-
- If you add a new option to `config/tech-docs.yml`, make sure you [document the option in docs/configuration.md](docs/configuration.md)
|
7
|
-
- If you add a new option to the page frontmatter, make sure you [document the option in docs/frontmatter.md](docs/frontmatter.md)
|
8
|
-
- You can test your contribution using [unit tests](spec/govuk_tech_docs), [javascript tests](spec/javascripts) or [integration tests](spec/features)
|
9
|
-
- 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.
|
3
|
+
Everybody who uses this project is encouraged to contribute to this project.
|
data/README.md
CHANGED
@@ -1,4 +1,4 @@
|
|
1
|
-
# Tech Docs Template - gem
|
1
|
+
# DSS Tech Docs Template - gem
|
2
2
|
|
3
3
|
This repo contains the Ruby gem that distributes the [Tech Docs Template][tdt-template]. The Tech Docs Template is a [middleman template][mmt] that
|
4
4
|
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:
|
|
27
27
|
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:
|
28
28
|
|
29
29
|
```rb
|
30
|
-
gem '
|
30
|
+
gem 'dss_tech_docs', path: '../tech-docs-gem'
|
31
31
|
```
|
32
32
|
|
33
33
|
To view your changes locally run:
|
@@ -67,9 +67,7 @@ bundle exec rake jasmine:ci
|
|
67
67
|
|
68
68
|
## Releasing new versions
|
69
69
|
|
70
|
-
|
71
|
-
|
72
|
-
Travis will automatically release a [new version to Rubygems.org](https://rubygems.org/gems/govuk_tech_docs).
|
70
|
+
This is a manual process for now.
|
73
71
|
|
74
72
|
## Licence
|
75
73
|
|
data/VERSION.md
ADDED
data/dss_tech_docs.gemspec
CHANGED
@@ -5,7 +5,7 @@ require "govuk_tech_docs/version"
|
|
5
5
|
|
6
6
|
Gem::Specification.new do |spec|
|
7
7
|
spec.name = "dss_tech_docs"
|
8
|
-
spec.version =
|
8
|
+
spec.version = "0.1.1"
|
9
9
|
spec.authors = ["Digital Shared Services"]
|
10
10
|
spec.email = ["stephen.patterson@finance-ni.gov.uk"]
|
11
11
|
|
data/lib/source/layouts/core.erb
CHANGED
@@ -8,6 +8,9 @@
|
|
8
8
|
<meta name="robots" content="noindex">
|
9
9
|
<% end %>
|
10
10
|
|
11
|
+
<!-- GOV.UK NTA font has been overridden to Lato, so need to load it -->
|
12
|
+
<link href='http://fonts.googleapis.com/css?family=Lato:400,700' rel='stylesheet' type='text/css'>
|
13
|
+
|
11
14
|
<title><%= meta_tags.browser_title %></title>
|
12
15
|
|
13
16
|
<!--[if gt IE 8]><!--><%= stylesheet_link_tag :screen, media: 'screen' %><!--<![endif]-->
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: dss_tech_docs
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.1.
|
4
|
+
version: 0.1.1
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Digital Shared Services
|
8
8
|
autorequire:
|
9
9
|
bindir: exe
|
10
10
|
cert_chain: []
|
11
|
-
date: 2019-
|
11
|
+
date: 2019-06-12 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: activesupport
|
@@ -310,6 +310,7 @@ files:
|
|
310
310
|
- LICENCE
|
311
311
|
- README.md
|
312
312
|
- Rakefile
|
313
|
+
- VERSION.md
|
313
314
|
- docs/configuration.md
|
314
315
|
- docs/core-layout-without-sidebar.png
|
315
316
|
- docs/core-layout.png
|