Skip to content
This repository was archived by the owner on Nov 22, 2023. It is now read-only.

Commit 7f5da33

Browse files
robhettrickrobhettrick
committed
In the beginning...
0 parents  commit 7f5da33

15 files changed

Lines changed: 421 additions & 0 deletions

File tree

‎.gitignore‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
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
21+
22+
# Ignore .idea folder
23+
/.idea

‎.template_version‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
:remote: https://github.com/alphagov/tech-docs-template.git
3+
:revision: |-
4+
fatal: ambiguous argument 'head': unknown revision or path not in the working tree.
5+
Use '--' to separate paths from revisions, like this:
6+
'git <command> [<revision>...] -- [<file>...]'
7+
head

‎Gemfile‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
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'
13+
14+
# Include LiveReload
15+
gem 'middleman-livereload'

‎Gemfile.lock‎

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

‎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: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Host to use for canonical URL generation (without trailing slash)
2+
host:
3+
4+
# Header-related options
5+
show_govuk_logo: true
6+
service_name: Monitor my Satellite Tech Docs
7+
service_link: /
8+
phase: Beta
9+
10+
# Links to show on right-hand-side of header
11+
header_links:
12+
#About: /about
13+
#Get Started: at.service.gov.uk/get-started
14+
Documentation: /
15+
#Support: /support
16+
17+
# Enables search functionality. This indexes pages only and is not recommended for single-page sites.
18+
enable_search: true
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: false
25+
26+
# Enable collapsible navigation in the sidebar
27+
collapsible_nav: false
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: 6
33+
34+
# Prevent robots from indexing (e.g. whilst in development)
35+
prevent_indexing: false
36+
37+
show_contribution_banner: true
38+
github_repo: the-psc/sst-tech-docs

‎manifest.yml‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
applications:
3+
- name:
4+
memory: 64M
5+
instances: 2
6+
path: ./build
7+
buildpack: staticfile_buildpack

‎script/deploy‎

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
#!/bin/bash
2+
3+
set -e
4+
5+
error() {
6+
echo " ! $1"
7+
}
8+
9+
# Check that we have a Staticfile.auth we can use
10+
echo "Checking Staticfile.auth..."
11+
if [[ ! -f Staticfile.auth ]]; then
12+
error "You are attempting to deploy to an environment that requires a Staticfile.auth, but do not have one locally."
13+
error "Please add a Staticfile.auth file to this directory and try again."
14+
error
15+
error "For information on generating a Staticfile.auth, see"
16+
error "http://docs.cloudfoundry.org/buildpacks/staticfile/index.html#basic-auth"
17+
exit 1
18+
fi
19+
echo "OK!"
20+
21+
# Check that we're on master, or there's an environment variable set to override
22+
BRANCH=$(git rev-parse --abbrev-ref HEAD)
23+
24+
echo "Checking branch..."
25+
if [[ $BRANCH != "master" ]] && [[ $I_REALISE_I_AM_NOT_ON_MASTER != "y" ]]; then
26+
error "Current branch is not master, cowardly refusing to deploy"
27+
error "To force override, run this again with I_REALISE_I_AM_NOT_ON_MASTER=y"
28+
exit 1
29+
fi
30+
echo "OK!"
31+
32+
# Check that we've not got any uncommitted files in our working directory
33+
echo "Checking dirty working tree..."
34+
DIRTY_WORKING_TREE=$(git status --porcelain 2>/dev/null | egrep "^(M| M)" || exit 0)
35+
if [[ $DIRTY_WORKING_TREE != "" ]]; then
36+
error "There are uncommitted changes in the working directory."
37+
error "Please commit or stash all changes and try again."
38+
exit 1
39+
fi
40+
echo "OK!"
41+
42+
# Check if we're behind our Git remote
43+
echo "Checking if we're behind origin..."
44+
BEHIND_ORIGIN=$(git fetch origin >/dev/null 2>&1; git diff --stat HEAD...@{u})
45+
if [[ $BEHIND_ORIGIN != "" ]]; then
46+
error "You are behind the origin branch - please pull and try again."
47+
exit 1
48+
fi
49+
echo "OK!"
50+
51+
bundle exec middleman build
52+
cp Staticfile.auth build
53+
cf target -o govuk-service-manual -s integration
54+
cf push

‎source/documentation/index.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Documentation
2+
3+
This is a placeholder for the `Monitor my Satellite` service to publish its technical documentation to.

‎source/index.html.md.erb‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
title: Monitor my Satellite Documentation
3+
---
4+
5+
<%= partial 'documentation/index' %>

0 commit comments

Comments
 (0)