Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix preview instructions #340

Merged
merged 2 commits into from
Feb 21, 2025
Merged

fix preview instructions #340

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7cc953a
Upgrade to upstream Gemfile.lock
nacnudus Feb 19, 2025
0486c67
Update the instructions for previewing the site
nacnudus Feb 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
110 changes: 53 additions & 57 deletions Gemfile.lock
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,23 +1,23 @@
GEM
remote: https://rubygems.org/
specs:
activesupport (7.0.8)
activesupport (5.2.8.1)
concurrent-ruby (~> 1.0, >= 1.0.2)
i18n (>= 1.6, < 2)
minitest (>= 5.1)
tzinfo (~> 2.0)
addressable (2.8.4)
public_suffix (>= 2.0.2, < 6.0)
autoprefixer-rails (10.4.13.0)
i18n (>= 0.7, < 2)
minitest (~> 5.1)
tzinfo (~> 1.1)
addressable (2.8.7)
public_suffix (>= 2.0.2, < 7.0)
autoprefixer-rails (10.4.19.0)
execjs (~> 2)
backports (3.24.1)
backports (3.25.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.10)
commonmarker (0.23.11)
compass (1.0.3)
chunky_png (~> 1.2)
compass-core (~> 1.0.2)
Expand All @@ -30,19 +30,19 @@ GEM
sass (>= 3.3.0, < 3.5)
compass-import-once (1.0.5)
sass (>= 3.2, < 3.5)
concurrent-ruby (1.2.2)
contracts (0.16.1)
concurrent-ruby (1.3.5)
contracts (0.13.0)
dotenv (2.8.1)
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)
execjs (2.10.0)
fast_blank (1.0.1)
fastimage (2.2.7)
ffi (1.15.5)
govuk_tech_docs (3.4.0)
fastimage (2.4.0)
ffi (1.17.1)
govuk_tech_docs (3.5.0)
autoprefixer-rails (~> 10.2)
chronic (~> 0.10.2)
haml (< 6.0.0)
Expand All @@ -63,53 +63,51 @@ GEM
concurrent-ruby (~> 1.0)
hashie (3.6.0)
http_parser.rb (0.8.0)
i18n (1.6.0)
i18n (0.9.5)
concurrent-ruby (~> 1.0)
kramdown (2.4.0)
rexml
listen (3.8.0)
rb-fsevent (~> 0.10, >= 0.10.3)
rb-inotify (~> 0.9, >= 0.9.10)
kramdown (2.5.1)
rexml (>= 3.3.9)
listen (3.0.8)
rb-fsevent (~> 0.9, >= 0.9.4)
rb-inotify (~> 0.9, >= 0.9.7)
memoist (0.16.2)
middleman (4.5.0)
middleman (4.3.11)
coffee-script (~> 2.2)
haml (>= 4.0.5)
kramdown (>= 2.3.0)
middleman-cli (= 4.5.0)
middleman-core (= 4.5.0)
middleman-cli (= 4.3.11)
middleman-core (= 4.3.11)
middleman-autoprefixer (2.10.0)
autoprefixer-rails (>= 9.1.4)
middleman-core (>= 3.3.3)
middleman-cli (4.5.0)
middleman-cli (4.3.11)
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.5.0)
activesupport (>= 6.1, < 7.1)
addressable (~> 2.4)
middleman-core (4.3.11)
activesupport (>= 4.2, < 6.0)
addressable (~> 2.3)
backports (~> 3.6)
bundler (~> 2.0)
contracts (~> 0.13)
bundler
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)
i18n (~> 0.9.0)
listen (~> 3.0.0)
memoist (~> 0.14)
padrino-helpers (~> 0.15.0)
padrino-helpers (~> 0.13.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)
Expand All @@ -124,49 +122,47 @@ GEM
middleman-syntax (3.2.0)
middleman-core (>= 3.2)
rouge (~> 3.2)
mini_portile2 (2.8.6)
minitest (5.20.0)
mini_portile2 (2.8.8)
minitest (5.25.4)
multi_json (1.15.0)
nokogiri (1.16.5)
nokogiri (1.15.7)
mini_portile2 (~> 2.8.2)
racc (~> 1.4)
openapi3_parser (0.9.2)
commonmarker (~> 0.17)
padrino-helpers (0.15.3)
i18n (>= 0.6.7, < 2)
padrino-support (= 0.15.3)
padrino-helpers (0.13.3.4)
i18n (~> 0.6, >= 0.6.7)
padrino-support (= 0.13.3.4)
tilt (>= 1.4.1, < 3)
padrino-support (0.15.3)
parallel (1.23.0)
parslet (2.0.0)
public_suffix (5.0.1)
racc (1.7.3)
padrino-support (0.13.3.4)
activesupport (>= 3.1)
parallel (1.26.3)
public_suffix (5.1.1)
racc (1.8.1)
rack (2.2.11)
rack-livereload (0.3.17)
rack
rb-fsevent (0.11.2)
rb-inotify (0.10.1)
rb-inotify (0.11.1)
ffi (~> 1.0)
redcarpet (3.5.1)
rexml (3.3.9)
rexml (3.4.1)
rouge (3.30.0)
sass (3.4.25)
sassc (2.4.0)
ffi (~> 1.9)
servolux (0.13.0)
sprockets (4.2.0)
sprockets (4.2.1)
concurrent-ruby (~> 1.0)
rack (>= 2.2.4, < 4)
temple (0.10.2)
thor (1.2.2)
temple (0.10.3)
thor (1.3.2)
thread_safe (0.3.6)
tilt (2.0.11)
toml (0.3.0)
parslet (>= 1.8.0, < 3.0.0)
tzinfo (2.0.6)
concurrent-ruby (~> 1.0)
tzinfo (1.2.11)
thread_safe (~> 0.1)
uglifier (3.2.0)
execjs (>= 0.3.0, < 3)
webrick (1.8.2)

PLATFORMS
ruby
Expand All @@ -177,4 +173,4 @@ DEPENDENCIES
wdm (~> 0.1.0)

BUNDLED WITH
2.1.4
1.16.5
19 changes: 10 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Technical Documentation
# Technical Documentation

This project uses the [Tech Docs Template][template], which is a [Middleman template][mmt] that you can use to build technical documentation using a GOV.UK style.

Expand Down Expand Up @@ -57,14 +57,15 @@ You can add content by editing the `.html.md.erb` files. These files support con

## Preview your changes locally

- Install rbenv
- Install Ruby version 2.7.6 `rbenv install 2.7.6`
- Activate Ruby version 2.7.6 in your current terminal `rbenv shell 2.7.6`
- Install an old version of a dependency `rbenv exec gem install contracts -v 0.16.1`
- Install middleman `rbenv exec gem install middleman`
- Change directory into the website `cd <folder-name>`
- Install packages that the website requires `rbenv exec bundle install`
- View the website on your device `bundle exec middleman server`
1. Install rbenv.
2. Use git to clone this repository to your device.
3. In your terminal, navigate to the cloned repository on your device.
4. Install Ruby version 2.7.6 by running `rbenv install 2.7.6` in your terminal.
5. Activate Ruby version 2.7.6 in your current terminal by running `rbenv shell 2.7.6`.
6. Install a required version of the `bundler` gem by running `gem install bundler:1.16.5` in your terminal.
7. Install all the other required Ruby gems by running `rbenv exec bundle install`.
8. Make some changes to the content of the site, in the `source` directory.
9. Preview the changes by running `bundle exec middleman serve`.

👉 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.

Expand Down
19 changes: 11 additions & 8 deletions source/index.html.md.erb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ review_in: 6 months

# Data Services technical documentation

This site is a central store of technical documentation for the data community working on GOV.UK, and should be the default place to record information and decisions.
This site is a central store of technical documentation for the data community working on GOV.UK, and should be the default place to record information and decisions.
Any private or sensitive information should be linked to from here rather than written here directly.

Use this documentation if you need to find out information on:
Expand Down Expand Up @@ -43,19 +43,22 @@ You can add content by editing the `.html.md.erb` files. These files support con
3. Request review and get approval from another contributor
4. Merge the pull request

When the pull request is merged, GitHub will automatically render the changes that you made. It will take about a minute.
When the pull request is merged, GitHub will automatically render the changes that you made. It will take about a minute.
You can monitor the progress by viewing the [GitHub action][github-action] in your browser.

### Preview your changes

Follow the steps in the section [install the tech docs template](#install-the-tech-docs-template). Then follow the steps below.

1. Use git to clone this repository to your device.
2. Navigate to the cloned repository on your device.
3. Activate Ruby version 2.7.6 in your current terminal by running `rbenv shell 2.7.6`.
4. Use rbenv to install all the required Ruby gems by running `rbenv exec bundle install`.
5. Make some changes to the content of the site, in the `source` directory.
6. Preview the changes by running `bundle exec middleman serve`.
1. Install rbenv.
2. Use git to clone this repository to your device.
3. In your terminal, navigate to the cloned repository on your device.
4. Install Ruby version 2.7.6 by running `rbenv install 2.7.6` in your terminal.
5. Activate Ruby version 2.7.6 in your current terminal by running `rbenv shell 2.7.6`.
6. Install a required version of the `bundler` gem by running `gem install bundler:1.16.5` in your terminal.
7. Install all the other required Ruby gems by running `rbenv exec bundle install`.
8. Make some changes to the content of the site, in the `source` directory.
9. Preview the changes by running `bundle exec middleman serve`.

👉 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.

Expand Down