Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/alphagov/whitehall
Publishes government content on GOV.UK
https://github.com/alphagov/whitehall
container govuk govuk-publishing-frontend
Last synced: 23 days ago
JSON representation
Publishes government content on GOV.UK
- Host: GitHub
- URL: https://github.com/alphagov/whitehall
- Owner: alphagov
- License: mit
- Created: 2011-09-19T15:10:49.000Z (about 13 years ago)
- Default Branch: main
- Last Pushed: 2024-10-29T11:14:54.000Z (about 1 month ago)
- Last Synced: 2024-10-29T11:38:18.373Z (about 1 month ago)
- Topics: container, govuk, govuk-publishing-frontend
- Language: Ruby
- Homepage: https://docs.publishing.service.gov.uk/apps/whitehall.html
- Size: 188 MB
- Stars: 896
- Watchers: 136
- Forks: 194
- Open Issues: 30
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- Open-Source-Ruby-and-Rails-Apps - whitehall - a Ruby on Rails content management application for content published by government departments and agencies. 🔥 ✅ 🚀 (Happy Exploring 🤘)
- awesome - UK Gov
README
# Whitehall
Whitehall (also known as 'Whitehall Admin' or 'Whitehall Publisher') is used by publishers to create and manage content (e.g. ).
## Running the Application
**Use [GOV.UK Docker](https://github.com/alphagov/govuk-docker) to run any commands that follow.**
## Nomenclature
- *Govspeak* A variation of [Markdown](https://daringfireball.net/projects/markdown) used throughout whitehall as the general publishing format
## Technical documentation
This is a Ruby on Rails app, and should follow [our Rails app conventions](https://docs.publishing.service.gov.uk/manual/conventions-for-rails-applications.html).
You can use the [GOV.UK Docker environment](https://github.com/alphagov/govuk-docker) to run the application and its tests with all the necessary dependencies. Follow [the usage instructions](https://github.com/alphagov/govuk-docker#usage) to get started.
### Running the test suite
These commands assume you have the [GOV.UK Docker environment](https://github.com/alphagov/govuk-docker) running and its binaries in your PATH.
```
# run all the test suites
govuk-docker-run bundle exec rake
```
Javascript unit tests can also be run separately:
```
# run all the JavaScript tests
govuk-docker-run bundle exec rake jasmine
```
### Further documentation
See the [`docs/`](docs/) directory.
- [Content Audit Trail](docs/auditing.md)
- [CSS](docs/css.md)
- [Edition model](docs/edition_model.md)
- [Edition workflow](docs/edition_workflow.md)
- [How to publish a finder in whitehall](docs/finders.md)
- [Internationalisation](docs/internationalisation_guide.md)
- [JavaScript](docs/javascript.md)
- [Search Indexing](docs/search_indexing.md)
- [Timestamps](docs/timestamps.md)
- [Troubleshooting](docs/troubleshooting.md)
- [Adding a data migration](db/data_migration/README.md)
## Licence
[MIT License](LICENCE)