-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Andy Jones
committed
May 25, 2022
0 parents
commit 25c50b1
Showing
14 changed files
with
442 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,53 @@ | ||
name: Deploy Apply service standards in DfE to GitHub Pages | ||
|
||
on: | ||
push: | ||
branches: [main] | ||
|
||
jobs: | ||
build: | ||
name: Build website | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: Checkout | ||
uses: actions/checkout@v2 | ||
|
||
- name: Setup Ruby | ||
uses: ruby/setup-ruby@v1 | ||
with: | ||
ruby-version: '2.7.2' | ||
|
||
- name: Ruby gem cache | ||
uses: actions/cache@v2 | ||
with: | ||
path: vendor/bundle | ||
key: ${{ runner.os }}-gems-${{ hashFiles('**/Gemfile.lock') }} | ||
restore-keys: | | ||
${{ runner.os }}-gems- | ||
- name: Install Gems | ||
run: | | ||
bundle config path vendor/bundle | ||
bundle install --jobs 4 --retry 3 | ||
- name: Install node | ||
uses: actions/setup-node@v1 | ||
with: | ||
node-version: 13.x | ||
|
||
- name: Node packages cache | ||
uses: actions/cache@v2 | ||
with: | ||
path: ~/.npm | ||
key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }} | ||
restore-keys: | | ||
${{ runner.os }}-node- | ||
- name: Install packages | ||
run: npm install | ||
|
||
- name: Build Middleman | ||
run: bundle exec middleman build | ||
|
||
- name: Deploy to Github Pages | ||
uses: peaceiris/actions-gh-pages@v3 | ||
with: | ||
github_token: ${{ secrets.GITHUB_TOKEN }} | ||
publish_dir: ./build |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
# See http://help.github.com/ignore-files/ for more about ignoring files. | ||
# | ||
# If you find yourself ignoring temporary files generated by your text editor | ||
# or operating system, you probably want to add a global ignore instead: | ||
# git config --global core.excludesfile ~/.gitignore_global | ||
|
||
# Ignore bundler config | ||
/.bundle | ||
|
||
# Ignore the build directory | ||
/build | ||
|
||
# Ignore cache | ||
/.sass-cache | ||
/.cache | ||
|
||
# Ignore .DS_store file | ||
.DS_Store | ||
|
||
Staticfile.auth |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
--- | ||
:remote: https://github.com/alphagov/tech-docs-template.git | ||
:revision: cd9f2bb25a7e4ae71495d4e3715a78865de51905 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
# If you do not have OpenSSL installed, change | ||
# the following line to use 'http://' | ||
source 'https://rubygems.org' | ||
|
||
# For faster file watcher updates on Windows: | ||
gem 'wdm', '~> 0.1.0', platforms: [:mswin, :mingw, :x64_mingw] | ||
|
||
# Windows does not come with time zone data | ||
gem 'tzinfo-data', platforms: [:mswin, :mingw, :x64_mingw, :jruby] | ||
|
||
# Include the tech docs gem | ||
gem 'govuk_tech_docs' |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,181 @@ | ||
GEM | ||
remote: https://rubygems.org/ | ||
specs: | ||
activesupport (6.1.6) | ||
concurrent-ruby (~> 1.0, >= 1.0.2) | ||
i18n (>= 1.6, < 2) | ||
minitest (>= 5.1) | ||
tzinfo (~> 2.0) | ||
zeitwerk (~> 2.3) | ||
addressable (2.8.0) | ||
public_suffix (>= 2.0.2, < 5.0) | ||
autoprefixer-rails (10.4.7.0) | ||
execjs (~> 2) | ||
backports (3.23.0) | ||
chronic (0.10.2) | ||
chunky_png (1.4.0) | ||
coffee-script (2.4.1) | ||
coffee-script-source | ||
execjs | ||
coffee-script-source (1.12.2) | ||
commonmarker (0.23.4) | ||
compass (1.0.3) | ||
chunky_png (~> 1.2) | ||
compass-core (~> 1.0.2) | ||
compass-import-once (~> 1.0.5) | ||
rb-fsevent (>= 0.9.3) | ||
rb-inotify (>= 0.9) | ||
sass (>= 3.3.13, < 3.5) | ||
compass-core (1.0.3) | ||
multi_json (~> 1.0) | ||
sass (>= 3.3.0, < 3.5) | ||
compass-import-once (1.0.5) | ||
sass (>= 3.2, < 3.5) | ||
concurrent-ruby (1.1.10) | ||
contracts (0.13.0) | ||
dotenv (2.7.6) | ||
em-websocket (0.5.3) | ||
eventmachine (>= 0.12.9) | ||
http_parser.rb (~> 0) | ||
erubis (2.7.0) | ||
eventmachine (1.2.7) | ||
execjs (2.8.1) | ||
fast_blank (1.0.1) | ||
fastimage (2.2.6) | ||
ffi (1.15.5) | ||
govuk_tech_docs (3.2.1) | ||
autoprefixer-rails (~> 10.2) | ||
chronic (~> 0.10.2) | ||
middleman (~> 4.0) | ||
middleman-autoprefixer (~> 2.10.0) | ||
middleman-compass (>= 4.0.0) | ||
middleman-livereload | ||
middleman-search-gds | ||
middleman-sprockets (~> 4.0.0) | ||
middleman-syntax (~> 3.2.0) | ||
nokogiri | ||
openapi3_parser (~> 0.9.0) | ||
redcarpet (~> 3.5.1) | ||
haml (5.2.2) | ||
temple (>= 0.8.0) | ||
tilt | ||
hamster (3.0.0) | ||
concurrent-ruby (~> 1.0) | ||
hashie (3.6.0) | ||
http_parser.rb (0.8.0) | ||
i18n (1.6.0) | ||
concurrent-ruby (~> 1.0) | ||
kramdown (2.4.0) | ||
rexml | ||
listen (3.0.8) | ||
rb-fsevent (~> 0.9, >= 0.9.4) | ||
rb-inotify (~> 0.9, >= 0.9.7) | ||
memoist (0.16.2) | ||
middleman (4.4.2) | ||
coffee-script (~> 2.2) | ||
haml (>= 4.0.5) | ||
kramdown (>= 2.3.0) | ||
middleman-cli (= 4.4.2) | ||
middleman-core (= 4.4.2) | ||
middleman-autoprefixer (2.10.0) | ||
autoprefixer-rails (>= 9.1.4) | ||
middleman-core (>= 3.3.3) | ||
middleman-cli (4.4.2) | ||
thor (>= 0.17.0, < 2.0) | ||
middleman-compass (4.0.1) | ||
compass (>= 1.0.0, < 2.0.0) | ||
middleman-core (>= 4.0.0) | ||
middleman-core (4.4.2) | ||
activesupport (>= 6.1, < 7.0) | ||
addressable (~> 2.4) | ||
backports (~> 3.6) | ||
bundler (~> 2.0) | ||
contracts (~> 0.13.0) | ||
dotenv | ||
erubis | ||
execjs (~> 2.0) | ||
fast_blank | ||
fastimage (~> 2.0) | ||
hamster (~> 3.0) | ||
hashie (~> 3.4) | ||
i18n (~> 1.6.0) | ||
listen (~> 3.0.0) | ||
memoist (~> 0.14) | ||
padrino-helpers (~> 0.15.0) | ||
parallel | ||
rack (>= 1.4.5, < 3) | ||
sassc (~> 2.0) | ||
servolux | ||
tilt (~> 2.0.9) | ||
toml | ||
uglifier (~> 3.0) | ||
webrick | ||
middleman-livereload (3.4.7) | ||
em-websocket (~> 0.5.1) | ||
middleman-core (>= 3.3) | ||
rack-livereload (~> 0.3.15) | ||
middleman-search-gds (0.11.1) | ||
execjs (~> 2.6) | ||
middleman-core (>= 3.2) | ||
nokogiri (~> 1.6) | ||
middleman-sprockets (4.0.0) | ||
middleman-core (~> 4.0) | ||
sprockets (>= 3.0) | ||
middleman-syntax (3.2.0) | ||
middleman-core (>= 3.2) | ||
rouge (~> 3.2) | ||
mini_portile2 (2.8.0) | ||
minitest (5.15.0) | ||
multi_json (1.15.0) | ||
nokogiri (1.13.6) | ||
mini_portile2 (~> 2.8.0) | ||
racc (~> 1.4) | ||
openapi3_parser (0.9.2) | ||
commonmarker (~> 0.17) | ||
padrino-helpers (0.15.1) | ||
i18n (>= 0.6.7, < 2) | ||
padrino-support (= 0.15.1) | ||
tilt (>= 1.4.1, < 3) | ||
padrino-support (0.15.1) | ||
parallel (1.22.1) | ||
parslet (2.0.0) | ||
public_suffix (4.0.7) | ||
racc (1.6.0) | ||
rack (2.2.3) | ||
rack-livereload (0.3.17) | ||
rack | ||
rb-fsevent (0.11.1) | ||
rb-inotify (0.10.1) | ||
ffi (~> 1.0) | ||
redcarpet (3.5.1) | ||
rexml (3.2.5) | ||
rouge (3.28.0) | ||
sass (3.4.25) | ||
sassc (2.4.0) | ||
ffi (~> 1.9) | ||
servolux (0.13.0) | ||
sprockets (4.0.3) | ||
concurrent-ruby (~> 1.0) | ||
rack (> 1, < 3) | ||
temple (0.8.2) | ||
thor (1.2.1) | ||
tilt (2.0.10) | ||
toml (0.3.0) | ||
parslet (>= 1.8.0, < 3.0.0) | ||
tzinfo (2.0.4) | ||
concurrent-ruby (~> 1.0) | ||
uglifier (3.2.0) | ||
execjs (>= 0.3.0, < 3) | ||
webrick (1.7.0) | ||
zeitwerk (2.5.4) | ||
|
||
PLATFORMS | ||
ruby | ||
|
||
DEPENDENCIES | ||
govuk_tech_docs | ||
tzinfo-data | ||
wdm (~> 0.1.0) | ||
|
||
BUNDLED WITH | ||
2.1.4 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,77 @@ | ||
# Apply the Service Standard in DfE | ||
|
||
|
||
👉 You can find out more about setting up and managing content for this service on the [Tech Docs Template documentation](https://tdt-documentation.london.cloudapps.digital/) site. | ||
|
||
## Before you start | ||
|
||
To run this service on your machine, you need: | ||
|
||
- [Ruby][install-ruby] (2.7.2 version) | ||
- [Middleman][install-middleman] | ||
|
||
## Making changes | ||
|
||
To make changes to the documentation for the Tech Docs Template website, edit files in the `source` folder of this repository. | ||
|
||
You can add content by editing the `.html.md.erb` files. These files support content in: | ||
|
||
- Markdown | ||
- HTML | ||
- Ruby | ||
|
||
👉 You can use Markdown and HTML to generate different content types and Ruby partials to manage content. | ||
|
||
👉 Learn more about [producing more complex page structures](https://tdt-documentation.london.cloudapps.digital/configure_project/structure_docs/#structure-your-documentation). | ||
|
||
## Preview your changes locally | ||
|
||
To preview your new website locally, navigate to your project folder and run: | ||
|
||
```sh | ||
bundle exec middleman server | ||
``` | ||
|
||
👉 See the generated website on `http://localhost:4567` in your browser. Any content changes you make to your website will be updated in real time. | ||
|
||
To shut down the Middleman instance running on your machine, use `ctrl+C`. | ||
|
||
If you make changes to the `config/tech-docs.yml` configuration file, you need to restart Middleman to see the changes. | ||
|
||
## Build | ||
|
||
To build the HTML pages from content in your `source` folder, run: | ||
|
||
``` | ||
bundle exec middleman build | ||
``` | ||
|
||
Every time you run this command, the `build` folder gets generated from scratch. This means any changes to the `build` folder that are not part of the build command will get overwritten. | ||
|
||
## Troubleshooting | ||
|
||
Run `bundle update` to make sure you're using the most recent Ruby gem versions. | ||
|
||
Run `bundle exec middleman build --verbose` to get detailed error messages to help with finding the problem. | ||
|
||
## Licence | ||
|
||
Unless stated otherwise, the codebase is released under [the MIT License][mit]. | ||
This covers both the codebase and any sample code in the documentation. | ||
|
||
The documentation is [© Crown copyright][copyright] and available under the terms of the [Open Government 3.0][ogl] licence. | ||
|
||
[mit]: LICENCE | ||
[copyright]: http://www.nationalarchives.gov.uk/information-management/re-using-public-sector-information/uk-government-licensing-framework/crown-copyright/ | ||
[ogl]: http://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/ | ||
[mmt]: https://middlemanapp.com/advanced/project_templates/ | ||
[tdt-docs]: https://tdt-documentation.london.cloudapps.digital | ||
[config]: https://tdt-documentation.london.cloudapps.digital/configuration-options.html#configuration-options | ||
[frontmatter]: https://tdt-documentation.london.cloudapps.digital/frontmatter.html#frontmatter | ||
[multipage]: https://tdt-documentation.london.cloudapps.digital/multipage.html#build-a-multipage-site | ||
[example-content]: https://tdt-documentation.london.cloudapps.digital/content.html#content-examples | ||
[partials]: https://tdt-documentation.london.cloudapps.digital/single_page.html#add-partial-lines | ||
[install-ruby]: https://tdt-documentation.london.cloudapps.digital/install_macs.html#install-ruby | ||
[install-middleman]: https://tdt-documentation.london.cloudapps.digital/install_macs.html#install-middleman | ||
[gem]: https://github.com/alphagov/tech-docs-gem | ||
[template]: https://github.com/alphagov/tech-docs-template |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
require 'govuk_tech_docs' | ||
|
||
GovukTechDocs.configure(self) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
# Host to use for canonical URL generation (without trailing slash) | ||
host: apply-service-standard.education.gov.uk | ||
|
||
# Header-related options | ||
show_govuk_logo: false | ||
service_name: Apply the Service Standard in DfE | ||
service_link: https://apply-service-standard.education.gov.uk | ||
phase: ALPHA | ||
|
||
# Links to show on right-hand-side of header | ||
header_links: | ||
About: https://apply-service-standard.education.gov.uk/about | ||
Documentation: / | ||
|
||
# Enables search functionality. This indexes pages only and is not recommended for single-page sites. | ||
enable_search: true | ||
|
||
# Tracking ID from Google Analytics (e.g. UA-XXXX-Y) | ||
ga_tracking_id: UA-229786565 | ||
|
||
# Enable multipage navigation in the sidebar | ||
multipage_nav: true | ||
|
||
# Enable collapsible navigation in the sidebar | ||
collapsible_nav: true | ||
|
||
# Table of contents depth – how many levels to include in the table of contents. | ||
# If your ToC is too long, reduce this number and we'll only show higher-level | ||
# headings. | ||
max_toc_heading_level: 2 | ||
|
||
# Prevent robots from indexing (e.g. whilst in development) | ||
prevent_indexing: true | ||
|
||
show_contribution_banner: true | ||
github_repo: DFE-Digital/apply-service-standard-in-dfe |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Oops, something went wrong.