Skip to content

Commit 70532a6

Browse files
stevenjmesserstevenjmesser
committed
Replace old docs with Tech Docs Template
1 parent 28fa996 commit 70532a6

22 files changed

+473
-22
lines changed

‎.gitignore‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# See http://help.github.com/ignore-files/ for more about ignoring files.
2+
#
3+
# If you find yourself ignoring temporary files generated by your text editor
4+
# or operating system, you probably want to add a global ignore instead:
5+
# git config --global core.excludesfile ~/.gitignore_global
6+
7+
# Ignore bundler config
8+
/.bundle
9+
10+
# Ignore the build directory
11+
/build
12+
13+
# Ignore cache
14+
/.sass-cache
15+
/.cache
16+
17+
# Ignore .DS_store file
18+
.DS_Store
19+
20+
Staticfile.auth

‎.template_version‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
---
2+
:remote: https://github.com/alphagov/tech-docs-template.git
3+
:revision: b37e89431e84c6e23ce6941e8315b2bbcdd12c1a

‎Gemfile‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# If you do not have OpenSSL installed, change
2+
# the following line to use 'http://'
3+
source 'https://rubygems.org'
4+
5+
# For faster file watcher updates on Windows:
6+
gem 'wdm', '~> 0.1.0', platforms: [:mswin, :mingw, :x64_mingw]
7+
8+
# Windows does not come with time zone data
9+
gem 'tzinfo-data', platforms: [:mswin, :mingw, :x64_mingw, :jruby]
10+
11+
# Include the tech docs gem
12+
gem 'govuk_tech_docs'

‎Gemfile.lock‎

Lines changed: 179 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,179 @@
1+
GEM
2+
remote: https://rubygems.org/
3+
specs:
4+
activesupport (7.0.4.3)
5+
concurrent-ruby (~> 1.0, >= 1.0.2)
6+
i18n (>= 1.6, < 2)
7+
minitest (>= 5.1)
8+
tzinfo (~> 2.0)
9+
addressable (2.8.4)
10+
public_suffix (>= 2.0.2, < 6.0)
11+
autoprefixer-rails (10.4.13.0)
12+
execjs (~> 2)
13+
backports (3.24.1)
14+
chronic (0.10.2)
15+
chunky_png (1.4.0)
16+
coffee-script (2.4.1)
17+
coffee-script-source
18+
execjs
19+
coffee-script-source (1.12.2)
20+
commonmarker (0.23.9)
21+
compass (1.0.3)
22+
chunky_png (~> 1.2)
23+
compass-core (~> 1.0.2)
24+
compass-import-once (~> 1.0.5)
25+
rb-fsevent (>= 0.9.3)
26+
rb-inotify (>= 0.9)
27+
sass (>= 3.3.13, < 3.5)
28+
compass-core (1.0.3)
29+
multi_json (~> 1.0)
30+
sass (>= 3.3.0, < 3.5)
31+
compass-import-once (1.0.5)
32+
sass (>= 3.2, < 3.5)
33+
concurrent-ruby (1.2.2)
34+
contracts (0.16.1)
35+
dotenv (2.8.1)
36+
em-websocket (0.5.3)
37+
eventmachine (>= 0.12.9)
38+
http_parser.rb (~> 0)
39+
erubis (2.7.0)
40+
eventmachine (1.2.7)
41+
execjs (2.8.1)
42+
fast_blank (1.0.1)
43+
fastimage (2.2.6)
44+
ffi (1.15.5)
45+
govuk_tech_docs (3.3.1)
46+
autoprefixer-rails (~> 10.2)
47+
chronic (~> 0.10.2)
48+
middleman (~> 4.0)
49+
middleman-autoprefixer (~> 2.10.0)
50+
middleman-compass (>= 4.0.0)
51+
middleman-livereload
52+
middleman-search-gds
53+
middleman-sprockets (~> 4.0.0)
54+
middleman-syntax (~> 3.2.0)
55+
nokogiri
56+
openapi3_parser (~> 0.9.0)
57+
redcarpet (~> 3.5.1)
58+
haml (5.2.2)
59+
temple (>= 0.8.0)
60+
tilt
61+
hamster (3.0.0)
62+
concurrent-ruby (~> 1.0)
63+
hashie (3.6.0)
64+
http_parser.rb (0.8.0)
65+
i18n (1.6.0)
66+
concurrent-ruby (~> 1.0)
67+
kramdown (2.4.0)
68+
rexml
69+
listen (3.8.0)
70+
rb-fsevent (~> 0.10, >= 0.10.3)
71+
rb-inotify (~> 0.9, >= 0.9.10)
72+
memoist (0.16.2)
73+
middleman (4.4.3)
74+
coffee-script (~> 2.2)
75+
haml (>= 4.0.5, < 6.0)
76+
kramdown (>= 2.3.0)
77+
middleman-cli (= 4.4.3)
78+
middleman-core (= 4.4.3)
79+
middleman-autoprefixer (2.10.0)
80+
autoprefixer-rails (>= 9.1.4)
81+
middleman-core (>= 3.3.3)
82+
middleman-cli (4.4.3)
83+
thor (>= 0.17.0, < 2.0)
84+
middleman-compass (4.0.1)
85+
compass (>= 1.0.0, < 2.0.0)
86+
middleman-core (>= 4.0.0)
87+
middleman-core (4.4.3)
88+
activesupport (>= 6.1, < 7.1)
89+
addressable (~> 2.4)
90+
backports (~> 3.6)
91+
bundler (~> 2.0)
92+
contracts (~> 0.13)
93+
dotenv
94+
erubis
95+
execjs (~> 2.0)
96+
fast_blank
97+
fastimage (~> 2.0)
98+
hamster (~> 3.0)
99+
hashie (~> 3.4)
100+
i18n (~> 1.6.0)
101+
listen (~> 3.0)
102+
memoist (~> 0.14)
103+
padrino-helpers (~> 0.15.0)
104+
parallel
105+
rack (>= 1.4.5, < 3)
106+
sassc (~> 2.0)
107+
servolux
108+
tilt (~> 2.0.9)
109+
toml
110+
uglifier (~> 3.0)
111+
webrick
112+
middleman-livereload (3.4.7)
113+
em-websocket (~> 0.5.1)
114+
middleman-core (>= 3.3)
115+
rack-livereload (~> 0.3.15)
116+
middleman-search-gds (0.11.2)
117+
execjs (~> 2.6)
118+
middleman-core (>= 3.2)
119+
nokogiri (~> 1.6)
120+
middleman-sprockets (4.0.0)
121+
middleman-core (~> 4.0)
122+
sprockets (>= 3.0)
123+
middleman-syntax (3.2.0)
124+
middleman-core (>= 3.2)
125+
rouge (~> 3.2)
126+
mini_portile2 (2.8.1)
127+
minitest (5.18.0)
128+
multi_json (1.15.0)
129+
nokogiri (1.14.3)
130+
mini_portile2 (~> 2.8.0)
131+
racc (~> 1.4)
132+
openapi3_parser (0.9.2)
133+
commonmarker (~> 0.17)
134+
padrino-helpers (0.15.3)
135+
i18n (>= 0.6.7, < 2)
136+
padrino-support (= 0.15.3)
137+
tilt (>= 1.4.1, < 3)
138+
padrino-support (0.15.3)
139+
parallel (1.22.1)
140+
parslet (2.0.0)
141+
public_suffix (5.0.1)
142+
racc (1.6.2)
143+
rack (2.2.6.4)
144+
rack-livereload (0.3.17)
145+
rack
146+
rb-fsevent (0.11.2)
147+
rb-inotify (0.10.1)
148+
ffi (~> 1.0)
149+
redcarpet (3.5.1)
150+
rexml (3.2.5)
151+
rouge (3.30.0)
152+
sass (3.4.25)
153+
sassc (2.4.0)
154+
ffi (~> 1.9)
155+
servolux (0.13.0)
156+
sprockets (4.2.0)
157+
concurrent-ruby (~> 1.0)
158+
rack (>= 2.2.4, < 4)
159+
temple (0.10.0)
160+
thor (1.2.1)
161+
tilt (2.0.11)
162+
toml (0.3.0)
163+
parslet (>= 1.8.0, < 3.0.0)
164+
tzinfo (2.0.6)
165+
concurrent-ruby (~> 1.0)
166+
uglifier (3.2.0)
167+
execjs (>= 0.3.0, < 3)
168+
webrick (1.8.1)
169+
170+
PLATFORMS
171+
ruby
172+
173+
DEPENDENCIES
174+
govuk_tech_docs
175+
tzinfo-data
176+
wdm (~> 0.1.0)
177+
178+
BUNDLED WITH
179+
2.1.4

‎README.md‎

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,29 @@
1-
# Design System team docs
1+
# GOV.UK Design System Team Docs
22

3+
A reference guide for who we are and the way we do things. It's a playbook for anyone in the GOV.UK Design System team that tells us the 'right way' to do things.
4+
5+
What's written here is the way we do things now, but that will change from time to time.
6+
7+
## Technologies
8+
9+
The docs were built using the [Tech Docs Template](https://github.com/alphagov/tech-docs-template), which uses [Tech Docs Gem version 3.3.1](https://github.com/alphagov/tech-docs-gem/releases/tag/v3.3.1).
10+
11+
### Installation
12+
13+
_To be added._
14+
15+
## Contributing
16+
17+
Contributions from the team are always welcome!
18+
19+
We continually update this playbook because we're always looking for better ways to get things done. And that changes over time, especially as who works on the team and what we work on changes too.
20+
21+
See `contributing.md` for ways to get started.
22+
23+
## Acknowledgements
24+
25+
This guide was inspired by [dxw's Playbook](https://github.com/dxw/playbook).
26+
27+
## License
28+
29+
_Needs adding, but either OGL or MIT._

development/code-reviews.md renamed to _drafts/development/code-reviews.md

File renamed without changes.

development/commit-messages.md renamed to _drafts/development/commit-messages.md

File renamed without changes.

development/pair-and-mob-programming.md renamed to _drafts/development/pair-and-mob-programming.md

File renamed without changes.

‎config.rb‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
require 'govuk_tech_docs'
2+
3+
GovukTechDocs.configure(self)

‎config/tech-docs.yml‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Host to use for canonical URL generation (without trailing slash)
2+
host: team-docs.design-system.service.gov.uk
3+
4+
# Header-related options
5+
show_govuk_logo: true
6+
service_name: Name of API
7+
service_link: https://www.larry-the-cat.service.gov.uk
8+
phase: Beta
9+
10+
# Links to show on right-hand-side of header
11+
header_links:
12+
About: https://www.larry-the-cat.service.gov.uk/about
13+
Get Started: https://www.larry-the-cat.service.gov.uk/get-started
14+
Documentation: /
15+
Support: https://www.larry-the-cat.service.gov.uk/support
16+
17+
# Enables search functionality. This indexes pages only and is not recommended for single-page sites.
18+
enable_search: false
19+
20+
# Tracking ID from Google Analytics (e.g. UA-XXXX-Y)
21+
ga_tracking_id:
22+
23+
# Enable multipage navigation in the sidebar
24+
multipage_nav: true
25+
26+
# Enable collapsible navigation in the sidebar
27+
collapsible_nav: true
28+
29+
# Table of contents depth – how many levels to include in the table of contents.
30+
# If your ToC is too long, reduce this number and we'll only show higher-level
31+
# headings.
32+
max_toc_heading_level: 2
33+
34+
# Prevent robots from indexing (e.g. whilst in development)
35+
prevent_indexing: false
36+
37+
show_contribution_banner: true
38+
github_repo: alphagov/YOUR_REPO
39+
github_branch: main

0 commit comments

Comments
 (0)