https://github.com/alphagov/govuk-content-api-docs
Documentation for the GOV.UK Content API.
https://github.com/alphagov/govuk-content-api-docs
govuk tech-docs-template
Last synced: about 1 year ago
JSON representation
Documentation for the GOV.UK Content API.
- Host: GitHub
- URL: https://github.com/alphagov/govuk-content-api-docs
- Owner: alphagov
- License: mit
- Created: 2017-08-07T09:37:43.000Z (almost 9 years ago)
- Default Branch: main
- Last Pushed: 2025-05-07T08:46:04.000Z (about 1 year ago)
- Last Synced: 2025-05-08T22:51:51.890Z (about 1 year ago)
- Topics: govuk, tech-docs-template
- Language: HTML
- Homepage: https://content-api.publishing.service.gov.uk
- Size: 1.57 MB
- Stars: 4
- Watchers: 56
- Forks: 7
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# GOV.UK Content API Documentation
This is a microsite for providing documentation for the GOV.UK Content API. It
is hosted at https://content-api.publishing.service.gov.uk.
This documentation is built from source files in this repository and an
[OpenAPI](https://github.com/OAI/OpenAPI-Specification) specification
[file][content-store-openapi] for the
[Content Store][content-store] application.
The framework for this documentation
is provided by the [GOV.UK Tech Docs Template][tech-docs-template].
## Updating content
The [`reference.html`][reference-page] page is built using the
[`openapi.yaml`][content-store-openapi] file. Changes to content on this page
should be made by opening a pull request against the
[Content Store][content-store] application.
Other HTML pages are in the [`/source`][source-dir] of this repository and are
authored using Markdown. You can suggest edits to these pages by making changes
in a branch or fork of this project and then opening a pull request.
## Running documentation locally
To run the documentation locally you should have this repository checked out
as well as the [Content Store][content-store].
### Installing dependencies
Setting up the documentation requires Ruby. Run the following to install the
necessary dependencies:
```
make requirements
```
### Preview changes
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 on HTML pages. However for changes to
[`openapi.yaml`][content-store-openapi] you will need to restart the preview.
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:
```
make server
```
You should now be able to view a live preview at http://localhost:4567.
## Publishing changes
The main branch of this repository is published every 30 minutes to the
`gh-pages` branch. It uses the `deployed-to-production` branch of
[Content Store][content-store]. Thus once a pull request is merged into main
changes will automatically display on the site within 30 minutes.
If for some reason the automatic deployment fails you can deploy with the
following command:
```
make publish
```
This will push to the `gh-pages` branch and therefore deploy to GitHub Pages.
## License
[MIT License](LICENCE)
[content-store-openapi]: https://github.com/alphagov/content-store/blob/main/openapi.yaml
[content-store]: https://github.com/alphagov/content-store
/templates
[source-dir]: https://github.com/alphagov/govuk-content-api-docs/tree/main/source
[reference-page]: https://content-api.publishing.service.gov.uk/reference.html
[tech-docs-template]: https://github.com/alphagov/tech-docs-template
[rvm]: https://www.ruby-lang.org/en/documentation/installation/#managers
[bundler]: http://bundler.io/