EES-5607 Move public API docs into main repo

.ruby-version

@@ -0,0 +1 @@
+3.3.5

src/explore-education-statistics-api-docs/.gitignore

@@ -0,0 +1,16 @@
+.idea
+
+# Ignore bundler config
+/.bundle
+
+# Ignore the build directory
+/build
+
+# Ignore cache
+/.sass-cache
+/.cache
+
+# Ignore .DS_store file
+.DS_Store
+
+Staticfile.auth

src/explore-education-statistics-api-docs/Gemfile

@@ -0,0 +1,22 @@
+source 'https://rubygems.org'
+
+ruby '3.3.5'
+
+# For faster file watcher updates on Windows:
+gem 'wdm', '~> 0.1.0', platforms: [:mswin, :mingw]
+
+# Windows does not come with time zone data
+gem 'tzinfo-data', platforms: [:mswin, :mingw, :jruby]
+
+gem 'govuk_tech_docs'
+
+gem 'middleman-gh-pages'
+
+# Include linter to check for dead internal links
+gem 'html-proofer'
+
+gem 'chronic'
+
+gem 'http'
+
+gem 'rake'

src/explore-education-statistics-api-docs/Gemfile.lock

@@ -0,0 +1,270 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    Ascii85 (1.1.1)
+    activesupport (7.0.8.6)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    addressable (2.8.7)
+      public_suffix (>= 2.0.2, < 7.0)
+    afm (0.2.2)
+    async (2.17.0)
+      console (~> 1.26)
+      fiber-annotation
+      io-event (~> 1.6, >= 1.6.5)
+    autoprefixer-rails (10.4.19.0)
+      execjs (~> 2)
+    backports (3.25.0)
+    base64 (0.2.0)
+    bigdecimal (3.1.8)
+    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)
+    compass (1.0.3)
+      chunky_png (~> 1.2)
+      compass-core (~> 1.0.2)
+      compass-import-once (~> 1.0.5)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9)
+      sass (>= 3.3.13, < 3.5)
+    compass-core (1.0.3)
+      multi_json (~> 1.0)
+      sass (>= 3.3.0, < 3.5)
+    compass-import-once (1.0.5)
+      sass (>= 3.2, < 3.5)
+    concurrent-ruby (1.3.4)
+    console (1.27.0)
+      fiber-annotation
+      fiber-local (~> 1.1)
+      json
+    contracts (0.16.1)
+    csv (3.3.0)
+    domain_name (0.6.20240107)
+    dotenv (3.1.4)
+    em-websocket (0.5.3)
+      eventmachine (>= 0.12.9)
+      http_parser.rb (~> 0)
+    erubis (2.7.0)
+    ethon (0.16.0)
+      ffi (>= 1.15.0)
+    eventmachine (1.2.7)
+    execjs (2.10.0)
+    fast_blank (1.0.1)
+    fastimage (2.3.1)
+    ffi (1.17.0)
+    ffi-compiler (1.3.2)
+      ffi (>= 1.15.5)
+      rake
+    fiber-annotation (0.2.0)
+    fiber-local (1.1.0)
+      fiber-storage
+    fiber-storage (1.0.0)
+    google-protobuf (4.28.3)
+      bigdecimal
+      rake (>= 13)
+    govuk_tech_docs (4.1.0)
+      autoprefixer-rails (~> 10.2)
+      base64
+      bigdecimal
+      chronic (~> 0.10.2)
+      csv
+      haml (~> 6.0)
+      middleman (~> 4.0)
+      middleman-autoprefixer (~> 2.10)
+      middleman-compass (~> 4.0)
+      middleman-livereload
+      middleman-search-gds
+      middleman-sprockets (~> 4.0.0)
+      middleman-syntax (~> 3.4)
+      mutex_m
+      nokogiri
+      openapi3_parser (~> 0.9.0)
+      redcarpet (~> 3.6)
+      sassc-embedded (~> 1.78.0)
+      terser (~> 1.2.3)
+    haml (6.3.0)
+      temple (>= 0.8.2)
+      thor
+      tilt
+    hamster (3.0.0)
+      concurrent-ruby (~> 1.0)
+    hashery (2.1.2)
+    hashie (3.6.0)
+    html-proofer (5.0.9)
+      addressable (~> 2.3)
+      async (~> 2.1)
+      nokogiri (~> 1.13)
+      pdf-reader (~> 2.11)
+      rainbow (~> 3.0)
+      typhoeus (~> 1.3)
+      yell (~> 2.0)
+      zeitwerk (~> 2.5)
+    http (5.2.0)
+      addressable (~> 2.8)
+      base64 (~> 0.1)
+      http-cookie (~> 1.0)
+      http-form_data (~> 2.2)
+      llhttp-ffi (~> 0.5.0)
+    http-cookie (1.0.7)
+      domain_name (~> 0.5)
+    http-form_data (2.3.0)
+    http_parser.rb (0.8.0)
+    i18n (1.6.0)
+      concurrent-ruby (~> 1.0)
+    io-event (1.7.3)
+    json (2.7.4)
+    kramdown (2.4.0)
+      rexml
+    listen (3.9.0)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    llhttp-ffi (0.5.0)
+      ffi-compiler (~> 1.0)
+      rake (~> 13.0)
+    memoist (0.16.2)
+    middleman (4.5.1)
+      coffee-script (~> 2.2)
+      haml (>= 4.0.5)
+      kramdown (>= 2.3.0)
+      middleman-cli (= 4.5.1)
+      middleman-core (= 4.5.1)
+    middleman-autoprefixer (2.10.0)
+      autoprefixer-rails (>= 9.1.4)
+      middleman-core (>= 3.3.3)
+    middleman-cli (4.5.1)
+      thor (>= 0.17.0, < 1.3.0)
+    middleman-compass (4.0.1)
+      compass (>= 1.0.0, < 2.0.0)
+      middleman-core (>= 4.0.0)
+    middleman-core (4.5.1)
+      activesupport (>= 6.1, < 7.1)
+      addressable (~> 2.4)
+      backports (~> 3.6)
+      bundler (~> 2.0)
+      contracts (~> 0.13, < 0.17)
+      dotenv
+      erubis
+      execjs (~> 2.0)
+      fast_blank
+      fastimage (~> 2.0)
+      hamster (~> 3.0)
+      hashie (~> 3.4)
+      i18n (~> 1.6.0)
+      listen (~> 3.0)
+      memoist (~> 0.14)
+      padrino-helpers (~> 0.15.0)
+      parallel
+      rack (>= 1.4.5, < 3)
+      sassc (~> 2.0)
+      servolux
+      tilt (~> 2.0.9)
+      toml
+      uglifier (~> 3.0)
+      webrick
+    middleman-gh-pages (0.4.1)
+      rake (> 0.9.3)
+    middleman-livereload (3.4.7)
+      em-websocket (~> 0.5.1)
+      middleman-core (>= 3.3)
+      rack-livereload (~> 0.3.15)
+    middleman-search-gds (0.11.2)
+      execjs (~> 2.6)
+      middleman-core (>= 3.2)
+      nokogiri (~> 1.6)
+    middleman-sprockets (4.0.0)
+      middleman-core (~> 4.0)
+      sprockets (>= 3.0)
+    middleman-syntax (3.4.0)
+      middleman-core (>= 3.2)
+      rouge (~> 3.2)
+    mini_portile2 (2.8.7)
+    minitest (5.25.1)
+    multi_json (1.15.0)
+    mutex_m (0.2.0)
+    nokogiri (1.16.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)
+      tilt (>= 1.4.1, < 3)
+    padrino-support (0.15.3)
+    parallel (1.26.3)
+    parslet (2.0.0)
+    pdf-reader (2.12.0)
+      Ascii85 (~> 1.0)
+      afm (~> 0.2.1)
+      hashery (~> 2.0)
+      ruby-rc4
+      ttfunk
+    public_suffix (6.0.1)
+    racc (1.8.1)
+    rack (2.2.10)
+    rack-livereload (0.3.17)
+      rack
+    rainbow (3.1.1)
+    rake (13.2.1)
+    rb-fsevent (0.11.2)
+    rb-inotify (0.11.1)
+      ffi (~> 1.0)
+    redcarpet (3.6.0)
+    rexml (3.3.9)
+    rouge (3.30.0)
+    ruby-rc4 (0.1.5)
+    sass (3.4.25)
+    sass-embedded (1.80.4)
+      google-protobuf (~> 4.28)
+      rake (>= 13)
+    sassc (2.4.0)
+      ffi (~> 1.9)
+    sassc-embedded (1.78.0)
+      sass-embedded (~> 1.78)
+    servolux (0.13.0)
+    sprockets (4.2.1)
+      concurrent-ruby (~> 1.0)
+      rack (>= 2.2.4, < 4)
+    temple (0.10.3)
+    terser (1.2.4)
+      execjs (>= 0.3.0, < 3)
+    thor (1.2.2)
+    tilt (2.0.11)
+    toml (0.3.0)
+      parslet (>= 1.8.0, < 3.0.0)
+    ttfunk (1.8.0)
+      bigdecimal (~> 3.1)
+    typhoeus (1.4.1)
+      ethon (>= 0.9.0)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    uglifier (3.2.0)
+      execjs (>= 0.3.0, < 3)
+    webrick (1.8.2)
+    yell (2.2.2)
+    zeitwerk (2.7.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  chronic
+  govuk_tech_docs
+  html-proofer
+  http
+  middleman-gh-pages
+  rake
+  tzinfo-data
+  wdm (~> 0.1.0)
+
+RUBY VERSION
+   ruby 3.3.5p100
+
+BUNDLED WITH
+   2.3.22

src/explore-education-statistics-api-docs/README.md

@@ -0,0 +1,46 @@
+# Explore education statistics API documentation
+
+This repository is used to generate the documentation website for the Explore education statistics API.
+It is based on the GOV.UK [Technical Documentation Template](https://tdt-documentation.london.cloudapps.digital/)
+for building 
+
+## Pre-requisites
+
+The following pre-requisite dependencies are required to get started:
+
+- [Node.js](https://nodejs.org/en/) v20+ (can be installed with [nvm](https://github.com/nvm-sh/nvm) or [fnm](https://github.com/Schniz/fnm))
+- [Ruby](https://www.ruby-lang.org/en/) v3.3.5 (can be installed with [rbenv](https://github.com/rbenv/rbenv) or [rvm](https://rvm.io/))
+
+As always, it's advisable to install any versions using a version manager to make it easier to upgrade 
+and keep aligned with the project.
+
+### Ubuntu
+
+If you are using Ubuntu, you may need to install the following dependencies before you can install
+Ruby and its required gems:
+
+```shell
+sudo apt install libssl-dev libyaml-dev
+```
+
+## Getting started
+
+Once the pre-requisites have been installed, follow these steps:
+
+1. Install the project's Ruby dependencies:
+
+    ```shell
+    bundle install
+    ```
+
+2. Start the development server:
+
+    ```shell
+    bundle exec middleman
+    ```
+
+    This will start the Middleman development server on [https://localhost:4567](https://localhost:4567).
+
+3. Optional. To automatically refresh the browser upon code changes, install the [LiveReload browser extension](https://chrome.google.com/webstore/detail/livereload/jnihajbhpnppcggbcgedagnkighmdlei?hl=en).
+
+For further guidance on how to develop this documentation, please visit the [Technical Documentation Template](https://tdt-documentation.london.cloudapps.digital/) website.