Sha256: 2188d22afe9444532bb44d5fd29fb5781ae98d27de829a312cee43d494a5faf6
Contents?: true
Size: 1.92 KB
Versions: 7
Compression:
Stored size: 1.92 KB
Contents
# Tech Docs Template - gem This repo is part of the [tech-docs-template](https://github.com/alphagov/tech-docs-template). ## Usage To [generate a new site with the template](https://github.com/alphagov/tech-docs-template#creating-a-new-documentation-project), see the tech-docs-template repo. ## Contributing 👉 [See CONTRIBUTING.md](CONTRIBUTING.md) ## Developing locally There are 2 ways to develop with this gem. The first is to point your site's Gemfile to your local checkout, and use it normally. This is good for if you want to see what effect your changes have to the actual site. ```rb gem 'govuk_tech_docs', path: '../tech-docs-gem' ``` The second is to use the example app in this repo. You can start it by ``` cd example bundle install bundle exec middleman serve ``` Your site will appear on <http://localhost:4567>. ## Tests We have some automated JavaScript tests that use [Jasmine][jas] as a test framework. To run the tests on your machine: - Run `bundle exec rake jasmine` - Navigate to `http://localhost:8888` in a browser of your choosing - Peruse the output of your tests Or, on the command line, run `bundle exec rake jasmine:ci`. ## Releasing new versions At the moment this gem has to be released manually. There's a [story on the Reliability Engineering backlog](https://trello.com/c/gRQ8OnBl) to automate this. To release a new version, create a new Pull Request that updates [version.rb](lib/govuk_tech_docs/version.rb) and [CHANGELOG.md](CHANGELOG.md). Don't mix this in with other changes - this makes it easier to find out what was released when. See [this PR to release a new version as an example](https://github.com/alphagov/tech-docs-gem/pull/15). [Owners of the Rubygem](https://rubygems.org/gems/govuk_tech_docs#gem__owners) can then run `rake release` to release a new version. ## License The gem is available as open source under the terms of the [MIT License](LICENSE). [jas]: https://jasmine.github.io/
Version data entries
7 entries across 7 versions & 1 rubygems