https://github.com/alphagov/datagovuk-tech-docs
This repo contains the tech docs for data.gov.uk
https://github.com/alphagov/datagovuk-tech-docs
govuk
Last synced: 8 months ago
JSON representation
This repo contains the tech docs for data.gov.uk
- Host: GitHub
- URL: https://github.com/alphagov/datagovuk-tech-docs
- Owner: alphagov
- Created: 2018-11-30T11:29:05.000Z (about 7 years ago)
- Default Branch: main
- Last Pushed: 2025-05-08T19:25:56.000Z (8 months ago)
- Last Synced: 2025-05-08T22:51:31.844Z (8 months ago)
- Topics: govuk
- Language: HTML
- Homepage: https://guidance.data.gov.uk/
- Size: 1.21 MB
- Stars: 19
- Watchers: 50
- Forks: 9
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Technical Documentation
## Getting started
To preview or build the website, we need to use the terminal.
Install Ruby with Rubygems, perferably with a [Ruby version manager][rvm],
and the [Bundler gem][bundler].
In the application folder type the following to install the required gems:
```
bundle install
```
## Making changes
To make changes edit the source files in the `source` folder.
### Single page output
Although a single page of HTML is generated the markdown is spread across
multiple files to make it easier to manage. They can be found in
`source/documentation`.
A new markdown file isn't automatically included in the generated output. If we
add a new markdown file at the location `source/documentation/agile/scrum.md`,
the following snippet in `source/index.html.md.erb`, includes it in the
generated output.
```
<%= partial 'documentation/agile/scrum' %>
```
Including files manually like this lets us specify the position they appear in
the page.
### Multiple pages
To add a completely new page, create a file with a `.html.md` extension in the `/source` directory.
For example, `source/about.html.md` will be accessible on .
## Preview
Whilst writing documentation we can run a middleman server to preview how the
published version will look in the browser. After saving a change the preview in
the browser will automatically refresh.
The preview is only available on our own computer. Others won't be able to
access it if they are given the link.
Type the following to start the server:
```
bundle exec middleman server
```
If all goes well something like the following output will be displayed:
```
== The Middleman is loading
== LiveReload accepting connections from ws://192.168.0.8:35729
== View your site at "http://Laptop.local:4567", "http://192.168.0.8:4567"
== Inspect your site configuration at "http://Laptop.local:4567/__middleman", "http://192.168.0.8:4567/__middleman"
```
You should now be able to view a live preview at http://localhost:4567.
## Building and Deploying
The generated documentation is hosted on GitHub Pages.
Deployment is an automatic process. Once a PR is merged the `deploy` pipeline will deploy the site to
GitHub Pages and create a commit on the [gh-pages][gh-pages] branch.
[rvm]: https://www.ruby-lang.org/en/documentation/installation/#managers
[bundler]: http://bundler.io/
[gh-pages]: https://github.com/alphagov/datagovuk-tech-docs/tree/gh-pages