HOLD - Documentation version 1 - Limited pilot with prototyping partners

biome.json

@@ -5,7 +5,8 @@
       "**/build/**",
       "node_modules/**",
       "package.json",
-      "pnpm-lock.yaml"
+      "pnpm-lock.yaml",
+      "docs/**"
     ]
   },
   "organizeImports": {

docs/.gitignore

@@ -0,0 +1,2 @@
+_site
+.DS_Store

docs/Gemfile

@@ -0,0 +1,9 @@
+source "https://rubygems.org"
+
+gem 'jekyll'
+group :jekyll_plugins do
+  gem 'jekyll-gfm-adminitions'
+  gem 'jekyll-optional-front-matter'
+  gem 'github-pages'
+end
+gem 'jekyll-remote-theme'

docs/Gemfile.lock

@@ -0,0 +1,248 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (~>7.0.7.1)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3.4)
+      tzinfo (~> 1.2.10)
+    addressable (~> 2.5.2)
+      public_suffix (~> 4.0)
+    coffee-script (~> 2.4.1)
+      coffee-script-source
+      execjs
+    coffee-script-source (~> 1.11.1)
+    colorator (~> 1.1.0)
+    commonmarker (~> 0.23.10)
+      ruby-enum (~> 0.5)
+    concurrent-ruby (~> 1.1.5)
+    dnsruby (~> 1.61.2)
+      addressable (~> 2.8.0)
+    em-websocket (~> 0.5.1)
+      eventmachine (>= 0.12.9)
+      http_parser.rb (~> 0.6.0)
+    ethon (~> 0.11.0)
+      ffi (~> 1.3.0)
+    eventmachine (~> 1.2.7)
+    execjs (~> 2.7.0)
+    faraday (~> 0.15.2)
+      multipart-post (~> 3)
+    ffi (~> 1.11.1)
+    forwardable-extended (~> 2.6.0)
+    gemoji (~> 3.0.0)
+    github-pages (191)
+      activesupport (~> 7.0.7.1)
+      github-pages-health-check (~> 1.8.1)
+      jekyll (~> 3.7.3)
+      jekyll-avatar (~> 0.6.0)
+      jekyll-coffeescript (~> 1.1.1)
+      jekyll-commonmark-ghpages (~> 0.1.5)
+      jekyll-default-layout (~> 0.1.4)
+      jekyll-feed (~> 0.10.0)
+      jekyll-gist (~> 1.5.0)
+      jekyll-github-metadata (~> 2.9.4)
+      jekyll-mentions (~> 1.4.1)
+      jekyll-optional-front-matter (~> 0.3.0)
+      jekyll-paginate (~> 1.1.0)
+      jekyll-readme-index (~> 0.2.0)
+      jekyll-redirect-from (~> 0.14.0)
+      jekyll-relative-links (~> 0.5.3)
+      jekyll-remote-theme (~> 0.3.1)
+      jekyll-sass-converter (~> 1.5.2)
+      jekyll-seo-tag (~> 2.5.0)
+      jekyll-sitemap (~> 1.2.0)
+      jekyll-swiss (~> 0.4.0)
+      jekyll-theme-architect (~> 0.1.1)
+      jekyll-theme-cayman (~> 0.1.1)
+      jekyll-theme-dinky (~> 0.1.1)
+      jekyll-theme-hacker (~> 0.1.1)
+      jekyll-theme-leap-day (~> 0.1.1)
+      jekyll-theme-merlot (~> 0.1.1)
+      jekyll-theme-midnight (~> 0.1.1)
+      jekyll-theme-minimal (~> 0.1.1)
+      jekyll-theme-modernist (~> 0.1.1)
+      jekyll-theme-primer (~> 0.5.3)
+      jekyll-theme-slate (~> 0.1.1)
+      jekyll-theme-tactile (~> 0.1.1)
+      jekyll-theme-time-machine (~> 0.1.1)
+      jekyll-titles-from-headings (~> 0.5.1)
+      jemoji (~> 0.10.1)
+      kramdown (~> 2.3.0)
+      liquid (~> 4.0.0)
+      listen (~> 3.1.5)
+      mercenary (~> 0.3)
+      minima (~> 2.5.0)
+      nokogiri (~> 1.16.5)
+      rouge (~> 2.2.1)
+      terminal-table (~> 1.4)
+    github-pages-health-check (~> 1.8.1)
+      addressable (~> 2.8.0)
+      dnsruby (~> 1.60)
+      octokit (~> 4.0)
+      public_suffix (~> 2.0)
+      typhoeus (~> 1.3)
+    html-pipeline (~> 2.8.4)
+      activesupport (~> 7.0.7.1)
+      nokogiri (~> 1.16.5)
+    http_parser.rb (~> 0.6.0)
+    i18n (~> 0.9.5)
+      concurrent-ruby (~> 1.0)
+    jekyll (~> 3.8.4)
+      addressable (~> 2.8.0)
+      colorator (~> 1.0)
+      em-websocket (~> 0.5)
+      i18n (~> 0.7)
+      jekyll-sass-converter (~> 1.0)
+      jekyll-watch (~> 2.0)
+      kramdown (~> 2.3.0)
+      liquid (~> 4.0)
+      mercenary (~> 0.3.3)
+      pathutil (~> 0.9)
+      rouge (~> 4.0)
+      safe_yaml (~> 1.0)
+    jekyll-avatar (~> 0.6.0)
+      jekyll (~> 3.0)
+    jekyll-coffeescript (~> 1.1.1)
+      coffee-script (~> 2.2)
+      coffee-script-source (~> 1.11.1)
+    jekyll-commonmark (~> 1.2.0)
+      commonmarker (~> 0.23.10)
+      jekyll (~> 4.0)
+    jekyll-commonmark-ghpages (~> 0.1.5)
+      commonmarker (~> 0.23.10)
+      jekyll-commonmark (~> 1)
+      rouge (~> 2)
+    jekyll-default-layout (~> 0.1.4)
+      jekyll (~> 3.0)
+    jekyll-feed (~> 0.10.0)
+      jekyll (~> 3.3)
+    jekyll-gist (~> 1.5.0)
+      octokit (~> 4.2)
+    jekyll-github-metadata (~> 2.9.4)
+      jekyll (~> 3.1)
+      octokit (~> 4.4.0)
+    jekyll-mentions (~> 1.4.1)
+      html-pipeline (~> 2.3)
+      jekyll (~> 3.0)
+    jekyll-optional-front-matter (~> 0.3.0)
+      jekyll (~> 3.0)
+    jekyll-paginate (~> 1.1.0)
+    jekyll-readme-index (~> 0.2.0)
+      jekyll (~> 3.0)
+    jekyll-redirect-from (~> 0.14.0)
+      jekyll (~> 3.3)
+    jekyll-relative-links (~> 0.5.3)
+      jekyll (~> 3.3)
+    jekyll-remote-theme (~> 0.3.1)
+      jekyll (~> 3.5)
+      rubyzip (~> 3.0)
+    jekyll-sass-converter (~> 1.5.2)
+      sass (~> 3.4)
+    jekyll-seo-tag (~> 2.5.0)
+      jekyll (~> 3.3)
+    jekyll-sitemap (~> 1.2.0)
+      jekyll (~> 3.3)
+    jekyll-swiss (~> 0.4.0)
+    jekyll-theme-architect (~> 0.1.1)
+      jekyll (~> 3.5)
+      jekyll-seo-tag (~> 2.0)
+    jekyll-theme-cayman (~> 0.1.1)
+      jekyll (~> 3.5)
+      jekyll-seo-tag (~> 2.0)
+    jekyll-theme-dinky (~> 0.1.1)
+      jekyll (~> 3.5)
+      jekyll-seo-tag (~> 2.0)
+    jekyll-theme-hacker (~> 0.1.1)
+      jekyll (~> 3.5)
+      jekyll-seo-tag (~> 2.0)
+    jekyll-theme-leap-day (~> 0.1.1)
+      jekyll (~> 3.5)
+      jekyll-seo-tag (~> 2.0)
+    jekyll-theme-merlot (~> 0.1.1)
+      jekyll (~> 3.5)
+      jekyll-seo-tag (~> 2.0)
+    jekyll-theme-midnight (~> 0.1.1)
+      jekyll (~> 3.5)
+      jekyll-seo-tag (~> 2.0)
+    jekyll-theme-minimal (~> 0.1.1)
+      jekyll (~> 3.5)
+      jekyll-seo-tag (~> 2.0)
+    jekyll-theme-modernist (~> 0.1.1)
+      jekyll (~> 3.5)
+      jekyll-seo-tag (~> 2.0)
+    jekyll-theme-primer (~> 0.5.3)
+      jekyll (~> 3.5)
+      jekyll-github-metadata (~> 2.9)
+      jekyll-seo-tag (~> 2.0)
+    jekyll-theme-slate (0.1.1)
+      jekyll (~> 3.5)
+      jekyll-seo-tag (~> 2.0)
+    jekyll-theme-tactile (~> 0.1.1)
+      jekyll (~> 3.5)
+      jekyll-seo-tag (~> 2.0)
+    jekyll-theme-time-machine (~> 0.1.1)
+      jekyll (~> 3.5)
+      jekyll-seo-tag (~> 2.0)
+    jekyll-titles-from-headings (~> 0.5.1)
+      jekyll (~> 3.3)
+    jekyll-watch (~> 2.2.1)
+      listen (~> 3.0)
+    jemoji (~> 0.10.1)
+      gemoji (~> 3.0)
+      html-pipeline (~> 2.2)
+      jekyll (~> 3.0)
+    kramdown (~> 2.3.0)
+    liquid (~> 4.0.0)
+    listen (~> 3.1.5)
+      rb-fsevent (~> 0.9.4)
+      rb-inotify (~> 0.9.7)
+      ruby_dep (~> 1.2)
+    mercenary (~> 0.3.6)
+    mini_portile2 (~> 2.4.0)
+    minima (~> 2.5.0)
+      jekyll (~> 3.5)
+      jekyll-feed (~> 0.9)
+      jekyll-seo-tag (~> 2.1)
+    minitest (~> 5.11.3)
+    multipart-post (~> 2.0.0)
+    nokogiri (~> 1.16.5)
+      mini_portile2 (~> 2.4.0)
+    octokit (~> 4.11.0)
+      sawyer (~> 0.8.0)
+    pathutil (~> 0.16.2)
+      forwardable-extended (~> 2.6)
+    public_suffix (~> 2.0.5)
+    rb-fsevent (~> 0.10.3)
+    rb-inotify (~> 0.10.0)
+      ffi (~> 1.0)
+    rouge (~> 2.2.1)
+    ruby-enum (~> 0.7.2)
+      i18n
+    ruby_dep (~> 1.5.0)
+    rubyzip (~> 2.0.0)
+    safe_yaml (~> 1.0.5)
+    sass (~> 3.7.4)
+      sass-listen (~> 4.0.0)
+    sass-listen (~> 4.0.0)
+      rb-fsevent (~> 0.9.4)
+      rb-inotify (~> 0.9.7)
+    sawyer (~> 0.8.1)
+      addressable (~> 2.8.0)
+      faraday (~> 1.0)
+    terminal-table (~> 1.8.0)
+      unicode-display_width (~> 1.1.1)
+    thread_safe (~> 0.3.6)
+    typhoeus (~> 1.3.0)
+      ethon (~> 0.9.0)
+    tzinfo (~> 1.2.10)
+      thread_safe (~> 0.1)
+    unicode-display_width (~> 1.4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  github-pages
+
+BUNDLED WITH
+   1.16.4

docs/_config.yml

@@ -0,0 +1,81 @@
+# Site settings
+title: GC Forms API
+repository: cds-snc/forms-api
+description: >-
+ This documentation site is for developers who want to use the GC Forms API to retrieve form submission data programmatically into their department’s web application or back-office system. 
+
+# Base configuration
+exclude: [".rvmrc", ".rbenv-version", "README.md", "Rakefile", "changelog.md"]
+markdown: kramdown, GFM
+lsi: false
+safe: true
+source: [your repo's top level directory]
+incremental: false
+highlighter: rouge
+gist:
+  noscript: false
+kramdown:
+  math_engine: mathjax
+  syntax_highlighter: rouge
+collections:
+  pages:
+    output: true
+    permalink: /:path/
+
+# Theme
+remote_theme: pages-themes/minimal@v0.2.0
+
+#Plugins
+plugins:
+- jekyll-coffeescript
+- jekyll-commonmark-ghpages
+- jekyll-default-layout
+- jekyll-gfm-admonitions
+- jekyll-gist
+- jekyll-github-metadata
+- jekyll-optional-front-matter
+- jekyll-paginate
+- jekyll-readme-index
+- jekyll-remote-theme
+- jekyll-relative-links
+- jekyll-titles-from-headings
+- jekyll-relative-links
+- jekyll-seo-tag
+- kramdown-parser-gfm 
+
+# Title
+name: GC Forms API
+subtitle: This documentation is for developers who want to use the GC Forms API to retrieve form submission data programmatically into their department’s web application or back-office system. 
+
+# When using this template with a project page set the baseurl to '/project-name'
+# For user/organization pages set this to an empty string
+# When working locally use jekyll serve --baseurl '' so that you can view everything at localhost:4000
+# See http://jekyllrb.com/docs/github-pages/ for more info
+#baseurl: ''
+baseurl: '/forms-api'
+
+# Author/Organization info to be displayed in the templates
+author:
+  name: GC Forms
+  url: https://articles.alpha.canada.ca/forms-formulaires/
+author2:
+  name: Canadian Digital Service
+  url: https://digital.canada.ca
+
+# Point the logo URL at a file in your repo or hosted elsewhere by your organization
+logourl:
+logoalt:
+
+# Repo list
+# List repos that you would like to appear on the homepage here
+repos:
+- name:
+  description:
+  url:
+
+# Style Variables
+brand_color: "#9d8cf2ff"
+
+# Offline caching
+offline_cache: false
+cache_name: DOCter-v1.1

docs/_data/menu.yml

@@ -0,0 +1,39 @@
+en:
+  home:
+    name: "Home"
+    url: "/home/"
+  getting-started:
+    name: "Getting started"
+    url: "/getting-started/"
+  authentication:
+    name: "Authentication"
+    url: "/authentication/"
+  making-requests:
+    name: "Making requests"
+    url: "/making-requests/"
+  monitoring:
+    name: "Monitoring"
+    url: "/monitoring/"
+  contact:
+    name: "Getting support"
+    url: "/getting-support/"
+
+fr:
+  accueil:
+    name: "Accueil"
+    url: "/accueil/"
+  getting-started:
+    name: "Pour commencer"
+    url: "/pour-commencer/"
+  authentication:
+    name: "Authentification"
+    url: "/authentification/"
+  making-requests:
+    name: "Effectuer des demandes"
+    url: "/effectuer-des-demandes/"
+  monitoring:
+    name: "Surveiller"
+    url: "/surveiller/"
+  contact:
+    name: "Obtenir du soutien"
+    url: "/obtenir-du-soutien/"