From 01647794913c5765c6548a2901059641228b2218 Mon Sep 17 00:00:00 2001 From: Anik Brazeau <38330843+anikbrazeau@users.noreply.github.com> Date: Thu, 17 Oct 2024 15:20:38 -0400 Subject: [PATCH 001/440] Create documentation --- documentation | 7 +++++++ 1 file changed, 7 insertions(+) create mode 100644 documentation diff --git a/documentation b/documentation new file mode 100644 index 00000000..d7ea8cc6 --- /dev/null +++ b/documentation @@ -0,0 +1,7 @@ +# GC Forms API Documentation + +## Welcome + +Welcome to the first iteration of the GC Forms application programming interface (API) and its technical documentation. This lite version of 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. + +Our goal is to guide you through setting up an initial integration and securely retrieving form submissions, while also being able to learn from you in the process (for example: what’s challenging or what’s confusing) and then integrate your feedback into our upcoming iterations. We appreciate your patience as we continue to fill in the gaps and iron out issues along the way. Your open and honest feedback will help us improve GC Forms and shape the future of this product. From f8e479d9759f15d334364480119dcad1bdb816dd Mon Sep 17 00:00:00 2001 From: Anik Brazeau <38330843+anikbrazeau@users.noreply.github.com> Date: Thu, 17 Oct 2024 15:22:05 -0400 Subject: [PATCH 002/440] Rename documentation to index.md --- documentation => index.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename documentation => index.md (100%) diff --git a/documentation b/index.md similarity index 100% rename from documentation rename to index.md From 8d7924c300f9d12dc196273f0f2429a2b9013869 Mon Sep 17 00:00:00 2001 From: Anik Brazeau <38330843+anikbrazeau@users.noreply.github.com> Date: Thu, 17 Oct 2024 15:39:15 -0400 Subject: [PATCH 003/440] Adding different types of content to documentation --- index.md | 142 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 142 insertions(+) diff --git a/index.md b/index.md index d7ea8cc6..a238fefb 100644 --- a/index.md +++ b/index.md @@ -1,7 +1,149 @@ # GC Forms API Documentation +(Version 1 - Pilot/trial - Limited to prototyping partners only) ## Welcome Welcome to the first iteration of the GC Forms application programming interface (API) and its technical documentation. This lite version of 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. Our goal is to guide you through setting up an initial integration and securely retrieving form submissions, while also being able to learn from you in the process (for example: what’s challenging or what’s confusing) and then integrate your feedback into our upcoming iterations. We appreciate your patience as we continue to fill in the gaps and iron out issues along the way. Your open and honest feedback will help us improve GC Forms and shape the future of this product. + +## Overview + +The purpose of the GC Forms API is to allow you to securely and reliably retrieve form submissions directly from an API endpoint. Our hope is that this will eventually alleviate the level of effort associated with the retrieval of data and the tedious confirmation flows for high volumes of form submissions. So, rather than having to manually download and sign off on the removal of responses to confirm their retrieval from the database, the API will automate the workflow with systems that talk to each other and exchange data. + +This first version of the documentation includes what you need to know about: +- Getting started +- Authentication +- Making requests +- Monitoring +- Getting support + +## Getting started + +### What you will need +- A [GC Forms staging account](https://forms-staging.cdssandbox.xyz/) (used for temporary testing only) +- A form set to deliver responses via “Download” in Settings +- A few “mock” responses submitted to the form +- A target system where you plan on receiving form submission data +- An API key (generated by you in Settings > API Access) +- Infrastructure development resources who can craft HTTP requests and use Azure or AWS to reach the API + +^ No infrastructure development capabilities available? +^ This first version of the API might not be ready for you just yet. Consider choosing an alternative no-code delivery option to get responses by email or download them from GC Forms instead. + +### Getting an API key + +**To create an API key for this initial integration testing:** +1. Sign in to [GC Forms staging](https://forms-staging.cdssandbox.xyz/) (used for temporary testing only). +2. Create a draft form. +3. Go to “Settings” in the side navigation and then “API Access” in the tab menu. +4. Click “Generate Key”. +5. Download JSON file that includes the private API key. + +^ **IMPORTANT!** +^ You must keep this API key secure as it is used to authenticate API requests and could be used to access protected data. Use encrypted email if you must share it with a developer team member to set up the integration. + +## Authentication + +### Base URL + +**Now: _Staging_** currently available for prototyping purposes (temporarily) +```https://api.forms-staging.cdssandbox.xyz/``` + +**Later: _Production_** coming soon, not yet avialable for real live forms (eventually) +```[https://api.forms-staging.cdssandbox.xyz/](https://api.forms-formulaires.alpha.canada.ca/)``` + +### How authentication works + +The GC Forms API leverages an OAuth 2.0 Signed JSON Web Token ([JWT](https://jwt.io/)) flow with a self-hosted Identity provider (IDP), Zitadel, to establish machine-to-machine authentication in a safe and secure way for the API endpoint. + +Authentication is done through an opaque token, with basic authorization handled via the user profile and the requested form ID. The OAuth server provides a short-lived access token that can be used to make API requests by verifying the client’s JWT that has been signed with a private key and includes their client ID. This access token is valid for 30 minutes. + +The API requires authentication with a Government of Canada email, an associated **formID**, a JWT signed with a **Private key** and verified using a **Public key** with the IDP. This token contains a claim to specify the form ID from which it is associated. + +#### Integration examples + +Once you’ve created a form, you can submit mock form submissions to simulate an active form and be able to test the integration. + +Use these examples as a reference to generate access tokens in your preferred programming language: +- [.NET / C#](https://github.com/cds-snc/forms-api/blob/main/examples/dotnet/AccessTokenGenerator.cs) +- [Node.JS / Typescript](https://github.com/cds-snc/forms-api/blob/main/examples/nodejs/accessTokenGenerator.ts) +- [Python](https://github.com/cds-snc/forms-api/blob/main/examples/python/access_token_generator.py) +- [Bash /Curl](https://github.com/cds-snc/forms-api/blob/main/examples/bash/get_access_token.sh) + +#### Authorization header + +Use this header for each API request to verify it’s you: + +``` +curl \ + --request GET "$FORMS_URL" \ + --header "Authorization: Bearer $ACCESS_TOKEN" +``` + +## Making requests + +The GC Forms API allows you to retrieve form submissions as files in JSON file format. You can get up to 100 form submissions in a batch, and these are available for up to 30 days after submission, given our current data retention periods. Form submissions are encrypted with a public key and can be decrypted by you locally. + +**Query parameters** +The API requests for GC Forms submission data are possible using query parameters such as: + + +- **{formID}** + 25-character alphanumeric string found at the end of the URL for the form or at the start of the + file name of the API key. + For example: ```clzvj8fzb00226o90r2b7l1gt```. + + +- **{SubmissionName}** + 11-character alphanumeric including dashes, sometimes also called the SubmissionID in the GC Forms + app. + For example: ```e02-08-d732```. + + +- **{ConfirmationCode}** + 36-character alphanumeric string that includes dashes, sometimes also called the Receipt code in the + GC Forms app. + For example: ```620b203c-9836-4000-bf30-1c3bcc26b834```. + +**Examples** + +We’ve developed some examples that you can reference or run the program for, that we hope will help make integration easier. Here are the programming languages currently available: + +- [.NET / C#](https://github.com/cds-snc/forms-api/tree/main/examples/dotnet) +- [Node.JS / Typescript](https://github.com/cds-snc/forms-api/tree/main/examples/nodejs) +- [Python](https://github.com/cds-snc/forms-api/tree/main/examples/python) +- [Bash /Curl](https://github.com/cds-snc/forms-api/tree/main/examples/bash) + +### Retrieving **new** form submissions + +#### HTTP request + +This URL path returns a list of submissions that includes the 100 oldest form submissions marked with a “New” status: + +```GET /forms/{formID}/submission/new``` + +_Note: The status of these form submissions will not change to “Downloaded”._ + +#### Response status + +| Status code | Example message | Meaning / how to fix | +| ----------- | --------------- | -------------------- | +| 200 | [ + ``` { + "name": "05-09-09f4", + "createdAt": 1725553403512 + }, + { + "name": "05-09-9620", + "createdAt": 1725553404965 + }, + { + "name": "05-09-75dc", + "createdAt": 1725553404972 + } +] +``` + | List of new submission names successfully retrieved. | + + From f78378b92e6798af015f6abcd81038fbcf6709bd Mon Sep 17 00:00:00 2001 From: Anik Brazeau <38330843+anikbrazeau@users.noreply.github.com> Date: Thu, 17 Oct 2024 15:42:16 -0400 Subject: [PATCH 004/440] Rename index.md to documentation/index.md Folder addition? --- index.md => documentation/index.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename index.md => documentation/index.md (100%) diff --git a/index.md b/documentation/index.md similarity index 100% rename from index.md rename to documentation/index.md From d547e2e937b36dc52086545ff883efc9d7865d5b Mon Sep 17 00:00:00 2001 From: Anik Brazeau <38330843+anikbrazeau@users.noreply.github.com> Date: Thu, 17 Oct 2024 16:20:46 -0400 Subject: [PATCH 005/440] Update index.md Add a theme to the site --- documentation/index.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/documentation/index.md b/documentation/index.md index a238fefb..d3bb8c67 100644 --- a/documentation/index.md +++ b/documentation/index.md @@ -1,3 +1,5 @@ +theme: jekyll-theme-minimal + # GC Forms API Documentation (Version 1 - Pilot/trial - Limited to prototyping partners only) From d78eb059f0c45e1f04b1086216e010f4998952cd Mon Sep 17 00:00:00 2001 From: Anik Brazeau <38330843+anikbrazeau@users.noreply.github.com> Date: Thu, 17 Oct 2024 16:23:36 -0400 Subject: [PATCH 006/440] Create default.html --- documentation/_layouts/default.html | 1 + 1 file changed, 1 insertion(+) create mode 100644 documentation/_layouts/default.html diff --git a/documentation/_layouts/default.html b/documentation/_layouts/default.html new file mode 100644 index 00000000..8b137891 --- /dev/null +++ b/documentation/_layouts/default.html @@ -0,0 +1 @@ + From dab2545a07e6119296c8470c6207e2d252fdab50 Mon Sep 17 00:00:00 2001 From: Anik Brazeau <38330843+anikbrazeau@users.noreply.github.com> Date: Thu, 17 Oct 2024 16:25:26 -0400 Subject: [PATCH 007/440] Create _config.yml --- documentation/_layouts/_config.yml | 2 ++ 1 file changed, 2 insertions(+) create mode 100644 documentation/_layouts/_config.yml diff --git a/documentation/_layouts/_config.yml b/documentation/_layouts/_config.yml new file mode 100644 index 00000000..96f2b52c --- /dev/null +++ b/documentation/_layouts/_config.yml @@ -0,0 +1,2 @@ +title: GC Forms API Documentation +description: 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. From 1fb4a5915a8237e651bff7168ad052df41208173 Mon Sep 17 00:00:00 2001 From: Anik Brazeau <38330843+anikbrazeau@users.noreply.github.com> Date: Thu, 17 Oct 2024 16:26:33 -0400 Subject: [PATCH 008/440] Update _config.yml --- documentation/_layouts/_config.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/documentation/_layouts/_config.yml b/documentation/_layouts/_config.yml index 96f2b52c..9f0d6856 100644 --- a/documentation/_layouts/_config.yml +++ b/documentation/_layouts/_config.yml @@ -1,2 +1,3 @@ title: GC Forms API Documentation description: 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. +theme: jekyll-theme-minimal From 2566de939144e49f6207a2d74301b52cb504c684 Mon Sep 17 00:00:00 2001 From: Anik Brazeau <38330843+anikbrazeau@users.noreply.github.com> Date: Thu, 17 Oct 2024 16:30:43 -0400 Subject: [PATCH 009/440] Create style.scss --- documentation/assets/css/style.scss | 4 ++++ 1 file changed, 4 insertions(+) create mode 100644 documentation/assets/css/style.scss diff --git a/documentation/assets/css/style.scss b/documentation/assets/css/style.scss new file mode 100644 index 00000000..5742f930 --- /dev/null +++ b/documentation/assets/css/style.scss @@ -0,0 +1,4 @@ +--- +--- + +@import "{{ site.theme }}"; From 1cbaee3b340674b247c1fdc0bf8679763da2a49e Mon Sep 17 00:00:00 2001 From: Anik Brazeau <38330843+anikbrazeau@users.noreply.github.com> Date: Thu, 17 Oct 2024 16:31:03 -0400 Subject: [PATCH 010/440] Rename documentation/_layouts/_config.yml to documentation/_config.yml --- documentation/{_layouts => }/_config.yml | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename documentation/{_layouts => }/_config.yml (100%) diff --git a/documentation/_layouts/_config.yml b/documentation/_config.yml similarity index 100% rename from documentation/_layouts/_config.yml rename to documentation/_config.yml From c454db50aa6a608e3b069b880536e0aa38b8177c Mon Sep 17 00:00:00 2001 From: Anik Brazeau <38330843+anikbrazeau@users.noreply.github.com> Date: Thu, 17 Oct 2024 16:40:45 -0400 Subject: [PATCH 011/440] Rename index.md to index.md --- {documentation => docs}/index.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename {documentation => docs}/index.md (100%) diff --git a/documentation/index.md b/docs/index.md similarity index 100% rename from documentation/index.md rename to docs/index.md From 1287fc895eae28f5a44221bb2f09ec576dfc4d6a Mon Sep 17 00:00:00 2001 From: Anik Brazeau <38330843+anikbrazeau@users.noreply.github.com> Date: Thu, 17 Oct 2024 16:41:19 -0400 Subject: [PATCH 012/440] Rename default.html to default.html --- {documentation => docs}/_layouts/default.html | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename {documentation => docs}/_layouts/default.html (100%) diff --git a/documentation/_layouts/default.html b/docs/_layouts/default.html similarity index 100% rename from documentation/_layouts/default.html rename to docs/_layouts/default.html From b565fade8dd0718bf2675a2941d2beb9f6756d8a Mon Sep 17 00:00:00 2001 From: Anik Brazeau <38330843+anikbrazeau@users.noreply.github.com> Date: Thu, 17 Oct 2024 16:41:58 -0400 Subject: [PATCH 013/440] Rename style.scss to style.scss --- {documentation => docs}/assets/css/style.scss | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename {documentation => docs}/assets/css/style.scss (100%) diff --git a/documentation/assets/css/style.scss b/docs/assets/css/style.scss similarity index 100% rename from documentation/assets/css/style.scss rename to docs/assets/css/style.scss From 5f563395cb9c209c38ca58810a48ca6850e5b385 Mon Sep 17 00:00:00 2001 From: Anik Brazeau <38330843+anikbrazeau@users.noreply.github.com> Date: Thu, 17 Oct 2024 16:42:19 -0400 Subject: [PATCH 014/440] Rename _config.yml to _config.yml --- {documentation => docs}/_config.yml | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename {documentation => docs}/_config.yml (100%) diff --git a/documentation/_config.yml b/docs/_config.yml similarity index 100% rename from documentation/_config.yml rename to docs/_config.yml From 233d363dfa55e41b79976afcbfc6727a56bc4027 Mon Sep 17 00:00:00 2001 From: Anik Brazeau <38330843+anikbrazeau@users.noreply.github.com> Date: Fri, 18 Oct 2024 14:09:44 -0400 Subject: [PATCH 015/440] Create menu.yml --- docs/menu.yml | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 docs/menu.yml diff --git a/docs/menu.yml b/docs/menu.yml new file mode 100644 index 00000000..2f82cbfa --- /dev/null +++ b/docs/menu.yml @@ -0,0 +1,19 @@ +en: + landing: + name: "Home" + url: "/" + 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/" From 1ec0c4700f49318d37452443b168e3301d586012 Mon Sep 17 00:00:00 2001 From: Anik Brazeau <38330843+anikbrazeau@users.noreply.github.com> Date: Wed, 23 Oct 2024 12:52:45 -0400 Subject: [PATCH 016/440] Create sw.js --- docs/sw.js | 38 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) create mode 100644 docs/sw.js diff --git a/docs/sw.js b/docs/sw.js new file mode 100644 index 00000000..b44ac23c --- /dev/null +++ b/docs/sw.js @@ -0,0 +1,38 @@ +--- +layout: null +--- + +importScripts( '{{ site.baseurl }}/cache-polyfill.js' ); + +var filesToCache = [ + // root + '{{ site.baseurl }}/', + '{{ site.baseurl }}/index.html', + // css + '{{ site.baseurl }}/assets/css/main.css', + '{{ site.baseurl }}/assets/css/normalize.css', + '{{ site.baseurl }}/assets/css/syntax.css', + // images + '{{ site.baseurl }}/assets/img/octocat.png', + // pages + {% for page in site.documents %}'{{ site.baseurl }}{{ page.url }}',{% endfor %} + // posts + {% for post in site.posts %}'{{ site.baseurl }}{{ post.url }}',{% endfor %} +]; + +self.addEventListener( 'install', function( e ) { + e.waitUntil( + caches.open( '{{ site.cache_name }}' ) + .then( function( cache ) { + return cache.addAll( filesToCache ); + }) + ); +}); + +self.addEventListener( 'fetch', function( event ) { + event.respondWith( + caches.match( event.request ).then( function( response ) { + return response || fetch( event.request ); + }) + ); +}); From d7bbfc816a2e07db27b03866b3972589884ffbae Mon Sep 17 00:00:00 2001 From: Anik Brazeau <38330843+anikbrazeau@users.noreply.github.com> Date: Wed, 23 Oct 2024 12:53:22 -0400 Subject: [PATCH 017/440] Create index.html --- docs/index.html | 8 ++++++++ 1 file changed, 8 insertions(+) create mode 100644 docs/index.html diff --git a/docs/index.html b/docs/index.html new file mode 100644 index 00000000..d97221c9 --- /dev/null +++ b/docs/index.html @@ -0,0 +1,8 @@ +--- +layout: default +lang: en +trans_url: /contexte +--- + +{% capture index %}{% include index.md %}{% endcapture %} +{{ index | markdownify }} From dd185243cc63a7d0b6607002a00d613cbca240c2 Mon Sep 17 00:00:00 2001 From: Anik Brazeau <38330843+anikbrazeau@users.noreply.github.com> Date: Wed, 23 Oct 2024 12:57:55 -0400 Subject: [PATCH 018/440] Update _config.yml --- docs/_config.yml | 46 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 46 insertions(+) diff --git a/docs/_config.yml b/docs/_config.yml index 9f0d6856..74bc3654 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -1,3 +1,49 @@ title: GC Forms API Documentation description: 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. theme: jekyll-theme-minimal + + +# Base configuration +exclude: [".rvmrc", ".rbenv-version", "README.md", "Rakefile", "changelog.md"] +markdown: kramdown +highlighter: rouge + +collections: + pages: + output: true + permalink: /:path/ + +# Title +name: GC Forms API Documentation +subtitle: How to retrieve form submissions from an API endpoint + +# 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: '/api-documentation' + +# Author/Organization info to be displayed in the templates +author: + 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: forms-api + description: GC Forms API + url: https://github.com/cds-snc/forms-api + + +# Style Variables +brand_color: "#FFCC3D" + +# Offline caching +offline_cache: false +cache_name: DOCter-v1.1 From 6cd096da0ff81cec410a022ee6c0a8b7681fa893 Mon Sep 17 00:00:00 2001 From: Anik Brazeau <38330843+anikbrazeau@users.noreply.github.com> Date: Wed, 23 Oct 2024 13:00:37 -0400 Subject: [PATCH 019/440] Create custom.css --- docs/assets/css/custom.css | 12 ++++++++++++ 1 file changed, 12 insertions(+) create mode 100644 docs/assets/css/custom.css diff --git a/docs/assets/css/custom.css b/docs/assets/css/custom.css new file mode 100644 index 00000000..30abf8b1 --- /dev/null +++ b/docs/assets/css/custom.css @@ -0,0 +1,12 @@ +.main-content p { + margin-top: 1.8em; + margin-bottom: 0.2em; +} + +.main-content ul { + margin-top: 0.3em; +} + +.main-content li { + margin-bottom: 0; +} From 815e1116e6857c1962244bd6a50e54795fc5397c Mon Sep 17 00:00:00 2001 From: Anik Brazeau <38330843+anikbrazeau@users.noreply.github.com> Date: Wed, 23 Oct 2024 13:01:11 -0400 Subject: [PATCH 020/440] Create main.css --- docs/assets/css/main.css | 541 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 541 insertions(+) create mode 100644 docs/assets/css/main.css diff --git a/docs/assets/css/main.css b/docs/assets/css/main.css new file mode 100644 index 00000000..25c1a606 --- /dev/null +++ b/docs/assets/css/main.css @@ -0,0 +1,541 @@ +--- +--- + +/* +Main.css +================================== +Begin with generic 'mobile first' styles +*/ + +/* +Normalize the box model +================================== +*/ + +*, +*:before, +*:after { + -webkit-box-sizing: border-box; + -moz-box-sizing: border-box; + box-sizing: border-box; + } + +/* +global styles +================================== +*/ + +html, body { + height: 100%; +} + +/* +Typography +================================== +*/ + +body { + font-family: "Avenir Next", Arial, sans-serif; + font-weight: 400; + font-style: normal; + line-height: 1.466666667; +} + +h1, +h3, +h4, +h5, +strong { + font-family: "Avenir Next Demi", "Avenir Next", Arial, sans-serif; + font-weight: 600; +} + +.site-title { + font-size: 1.625em; + font-family: "Avenir Next", Arial, sans-serif; + font-weight: normal; + color: #919395; + margin: 0; + line-height: 1.2941176470588236; + display: inline-block; + width: 70%; +} + +h2 { + font-weight: 600; + font-style: normal; + font-size: 1.375em; + margin: 1.4em 0 0 0; +} + +h4 { + font-size: 1em; + text-transform: uppercase; +} + +.page-title { + margin-top: .727272727em; /* 16/22 */ +} + +.float-right { + display: inline-block; + width: 25%; + margin: 0; + text-align: right; +} + +.language-switcher { +} +/* +Lists +-------------------------------- +*/ + +.main-content ul { + padding-left: 1.1em; +} + +.main-content li { + margin-bottom: 1em; +} + +li h3, +li h4 { + margin: 0; +} + +li p { + margin-top: 0; +} + +/* +Links +================================== +*/ + +a { + -webkit-transition: .2s; + -moz-transition: .2s; + transition: .2s; +} + +a, +a:link, +a:visited { + color: #0072ce; + border-bottom: 1px dotted #0072ce; + text-decoration: none; +} + +a:hover { + border-bottom: 1px solid #7eb8dd; + color: #7eb8dd; + text-decoration: none; +} + +a:active { + border-bottom: 1px solid #002d72; + color: #002d72; + text-decoration: none; +} + +a:focus { + border-bottom: 1px solid #0072ce; + color: #0072ce; + outline: thin dotted; + text-decoration: none; +} + +a.title-link { + color: #75787B; + border-bottom: none; +} + +a.title-link:hover, +a.title-link:active, +a.title-link:focus { + color: #7eb8dd; + border-bottom: none; +} + +a.skip-link { + color: #0072ce; + border-bottom: none; + padding: .25em; +} + +a.skip-link:hover, +a.skip-link:active, +a.skip-link:focus { + background-color: #0072ce; + color: #fff; + border-bottom: none; +} + + +/* +Navigation +================================== +*/ + +.sidebar-nav a { + display: block; + padding: 10px; + -webkit-transition: unset; + transition: unset; +} +.sidebar-nav a, +.sidebar-nav a:link, +.sidebar-nav a:visited { + border-bottom: none; + color: #75787b; +} +.sidebar-nav li:hover, +.sidebar-nav a:focus, +.sidebar-nav li:active, +.sidebar-nav .sidebar-nav-active { + color: #75787b; + border-left: 4px solid {{ site.brand_color }}; + background-color: transparent; + border-bottom: 1px solid #babbbd; +} +.sidebar-nav li:hover, +.sidebar-nav li:active, +.sidebar-nav .sidebar-nav-active { + padding-left: 0; +} +.sidebar-nav a:focus { + padding-left: 6px; +} +.sidebar-nav li:hover a:focus, +.sidebar-nav li:active a:focus { + border-left: none; + padding-left: 10px; +} +.sidebar-nav ul { + margin: 0; + padding: 0; + /*border-top: 1px solid @gray-50;*/ +} +.sidebar-nav li { + list-style: none; + border-bottom: 1px solid #babbbd; + font-size: 1.125em; + padding-left: 4px; +} +.sidebar-nav li:last-child { + border-bottom: none; +} + + +/* +Layout +================================== +*/ + +.logo { + display: block; +} + +.content { + padding-top: 2em; + padding-bottom: 2em; +} + +/* offset the fixed position header for jump links */ +section:before { + display: block; + content: ""; + height: 60px; + margin: -60px 0 0; +} + +.wrap { + max-width: 1200px; + margin: 0 auto; + padding-left: 20px; + padding-right: 20px; +} + +header { + width: 100%; + border-bottom: 4px solid {{ site.brand_color }}; + background-color: #fff; + padding: 2em 0; +} + + +/* +Footer +================================== +*/ + +/* for sticky footer */ +.container { + display: table; + height: 100%; + width: 100%; +} + +footer { + display: table-row; /* for sticky footer */ + height: 1px; /* for sticky footer */ + border-top: 2px solid #babbbd; + background: #f1f2f2; + width: 100%; + font-size: 0.875em; +} + +footer .wrap { + padding-top: 2em; + padding-bottom: 2em; +} + + +/* +Helpers +================================== +*/ + +/* Hide from both screenreaders and browsers: h5bp.com/u */ +.hidden { + display: none !important; + visibility: hidden; +} + +/* Hide only visually, but have it available for screenreaders: h5bp.com/v */ +.visuallyhidden { + border: 0; + clip: rect(0 0 0 0); + height: 1px; + margin: -1px; + overflow: hidden; + padding: 0; + position: absolute; + width: 1px; +} + +/* Extends the .visuallyhidden class to allow the element to be focusable + * when navigated to via the keyboard: h5bp.com/p */ +.visuallyhidden.focusable:active, +.visuallyhidden.focusable:focus { + clip: auto; + height: auto; + margin: 0; + overflow: visible; + position: static; + width: auto; +} + +/* Hide visually and from screenreaders, but maintain layout */ +.invisible { + visibility: hidden; +} + + +/* +Style +================================== +*/ + +.intro { + color: #75787B; +} + +li h4 { + margin: 0; +} + +.license { + font-family: "Avenir Next Demi", Arial, sans-serif; + font-weight: normal; + font-style: normal; +} + +pre { + max-width: 100%; + font-size: 0.875em; + overflow-y: scroll; + background-color: #f1f2f2; + padding: 10px; +} + +td, th { + border: 1px solid grey +} +/* +Post list +---------------------------------- +*/ + +ul.posts { + padding: 0; +} + +.posts li { + list-style: none; +} + +.post-date { + color: #75787B; +} + +/* +Repo list +---------------------------------- +*/ + +ul.repo-list { + margin: .5em 0 1em 0; + padding: 0; +} + +.repo-list li { + list-style: none; +} + +.repo-list p { + margin: 0; + font-size: 0.875em; +} + +.repo-list h4 { + text-transform: none; +} + +/* +Helper Classes +================================== +*/ + +/* +Clearfix list +---------------------------------- +*/ + +.group:before, +.group:after { + content: " "; + display: table; +} + +.group:after { + clear: both; +} + +.group { + *zoom: 1; +} + +/* +Desktop Styles +================================== +*/ + +@media screen and (min-width: 45em) and (min-height: 32.5em) { + + /* + Typography + ============================== + */ + + /* + Layout + ============================== + */ + + .logo { + max-width: 30%; + padding-right: 20px; + float: right; + } + + aside { + width: 30%; + float: left; + } + + .main-content { + width: 67%; + float: right; + margin-bottom: 120px; + } + + /* + Navigation + ============================== + */ + + + /* + Style + ============================== + */ + + /* + Repo list + ------------------------------ + */ + + .repo-list li { + list-style: none; + display: block; + float: left; + height: 4.0625em; + max-height: 4.0625em; + background-color: #E7E7E6; + border-left: 1px solid #BABBBD; + width: 30%; + } + + .repo-list a:link, + .repo-list a:visited { + display: block; + max-height: 4.0625em; + background-color: #E7E7E6; + border-bottom: none; + padding: .625em 1em 1em 1em; + } + + .repo-list a:hover { + color: #4D5F87; + background-color: #CDE3F1; + } + + .repo-list li:first-child { + text-align: center; + border-left: none; + line-height: 60px; + padding: .625em 1em; + width: 10%; + } + +} + +@media screen and (max-width: 54.375em) and (min-height: 32.5em) { + + /* keep the repo list containers the same height, but account for the need for more height */ + + .repo-list li { + height: 6em; + max-height: 6em; + } + + .repo-list a:link, + .repo-list a:visited { + max-height: 6em; + } +} + +/* +Mobile Styles +================================== +*/ + +@media screen and (max-width: 40.5em) { + + .main-content { + margin-top: 1.5em; + } + +} From 5efb5f15054204fd050ac014039fd56f26b4175f Mon Sep 17 00:00:00 2001 From: Anik Brazeau <38330843+anikbrazeau@users.noreply.github.com> Date: Wed, 23 Oct 2024 13:01:33 -0400 Subject: [PATCH 021/440] Create normalize.css --- docs/assets/css/normalize.css | 406 ++++++++++++++++++++++++++++++++++ 1 file changed, 406 insertions(+) create mode 100644 docs/assets/css/normalize.css diff --git a/docs/assets/css/normalize.css b/docs/assets/css/normalize.css new file mode 100644 index 00000000..c2de8df9 --- /dev/null +++ b/docs/assets/css/normalize.css @@ -0,0 +1,406 @@ +/*! normalize.css v2.1.3 | MIT License | git.io/normalize */ + +/* ========================================================================== + HTML5 display definitions + ========================================================================== */ + +/** + * Correct `block` display not defined in IE 8/9. + */ + +article, +aside, +details, +figcaption, +figure, +footer, +header, +hgroup, +main, +nav, +section, +summary { + display: block; +} + +/** + * Correct `inline-block` display not defined in IE 8/9. + */ + +audio, +canvas, +video { + display: inline-block; +} + +/** + * Prevent modern browsers from displaying `audio` without controls. + * Remove excess height in iOS 5 devices. + */ + +audio:not([controls]) { + display: none; + height: 0; +} + +/** + * Address `[hidden]` styling not present in IE 8/9. + * Hide the `template` element in IE, Safari, and Firefox < 22. + */ + +[hidden], +template { + display: none; +} + +/* ========================================================================== + Base + ========================================================================== */ + +/** + * 1. Set default font family to sans-serif. + * 2. Prevent iOS text size adjust after orientation change, without disabling + * user zoom. + */ + +html { + font-family: sans-serif; /* 1 */ + -ms-text-size-adjust: 100%; /* 2 */ + -webkit-text-size-adjust: 100%; /* 2 */ +} + +/** + * Remove default margin. + */ + +body { + margin: 0; +} + +/* ========================================================================== + Links + ========================================================================== */ + +/** + * Remove the gray background color from active links in IE 10. + */ + +a { + background: transparent; +} + +/** + * Address `outline` inconsistency between Chrome and other browsers. + */ + +a:focus { + outline: thin dotted; +} + +/** + * Improve readability when focused and also mouse hovered in all browsers. + */ + +a:active, +a:hover { + outline: 0; +} + +/* ========================================================================== + Typography + ========================================================================== */ + +/** + * Address variable `h1` font-size and margin within `section` and `article` + * contexts in Firefox 4+, Safari 5, and Chrome. + */ + +h1 { + font-size: 2em; + margin: 0.67em 0; +} + +/** + * Address styling not present in IE 8/9, Safari 5, and Chrome. + */ + +abbr[title] { + border-bottom: 1px dotted; +} + +/** + * Address style set to `bolder` in Firefox 4+, Safari 5, and Chrome. + */ + +b, +strong { + font-weight: bold; +} + +/** + * Address styling not present in Safari 5 and Chrome. + */ + +dfn { + font-style: italic; +} + +/** + * Address differences between Firefox and other browsers. + */ + +hr { + -moz-box-sizing: content-box; + box-sizing: content-box; + height: 0; +} + +/** + * Address styling not present in IE 8/9. + */ + +mark { + background: #ff0; + color: #000; +} + +/** + * Correct font family set oddly in Safari 5 and Chrome. + */ + +code, +kbd, +pre, +samp { + font-family: monospace, serif; + font-size: 1em; +} + +/** + * Improve readability of pre-formatted text in all browsers. + */ + +pre { + white-space: pre-wrap; +} + +/** + * Set consistent quote types. + */ + +q { + quotes: "\201C" "\201D" "\2018" "\2019"; +} + +/** + * Address inconsistent and variable font size in all browsers. + */ + +small { + font-size: 80%; +} + +/** + * Prevent `sub` and `sup` affecting `line-height` in all browsers. + */ + +sub, +sup { + font-size: 75%; + line-height: 0; + position: relative; + vertical-align: baseline; +} + +sup { + top: -0.5em; +} + +sub { + bottom: -0.25em; +} + +/* ========================================================================== + Embedded content + ========================================================================== */ + +/** + * Remove border when inside `a` element in IE 8/9. + */ + +img { + border: 0; +} + +/** + * Correct overflow displayed oddly in IE 9. + */ + +svg:not(:root) { + overflow: hidden; +} + +/* ========================================================================== + Figures + ========================================================================== */ + +/** + * Address margin not present in IE 8/9 and Safari 5. + */ + +figure { + margin: 0; +} + +/* ========================================================================== + Forms + ========================================================================== */ + +/** + * Define consistent border, margin, and padding. + */ + +fieldset { + border: 1px solid #c0c0c0; + margin: 0 2px; + padding: 0.35em 0.625em 0.75em; +} + +/** + * 1. Correct `color` not being inherited in IE 8/9. + * 2. Remove padding so people aren't caught out if they zero out fieldsets. + */ + +legend { + border: 0; /* 1 */ + padding: 0; /* 2 */ +} + +/** + * 1. Correct font family not being inherited in all browsers. + * 2. Correct font size not being inherited in all browsers. + * 3. Address margins set differently in Firefox 4+, Safari 5, and Chrome. + */ + +button, +input, +select, +textarea { + font-family: inherit; /* 1 */ + font-size: 100%; /* 2 */ + margin: 0; /* 3 */ +} + +/** + * Address Firefox 4+ setting `line-height` on `input` using `!important` in + * the UA stylesheet. + */ + +button, +input { + line-height: normal; +} + +/** + * Address inconsistent `text-transform` inheritance for `button` and `select`. + * All other form control elements do not inherit `text-transform` values. + * Correct `button` style inheritance in Chrome, Safari 5+, and IE 8+. + * Correct `select` style inheritance in Firefox 4+ and Opera. + */ + +button, +select { + text-transform: none; +} + +/** + * 1. Avoid the WebKit bug in Android 4.0.* where (2) destroys native `audio` + * and `video` controls. + * 2. Correct inability to style clickable `input` types in iOS. + * 3. Improve usability and consistency of cursor style between image-type + * `input` and others. + */ + +button, +html input[type="button"], /* 1 */ +input[type="reset"], +input[type="submit"] { + -webkit-appearance: button; /* 2 */ + cursor: pointer; /* 3 */ +} + +/** + * Re-set default cursor for disabled elements. + */ + +button[disabled], +html input[disabled] { + cursor: default; +} + +/** + * 1. Address box sizing set to `content-box` in IE 8/9/10. + * 2. Remove excess padding in IE 8/9/10. + */ + +input[type="checkbox"], +input[type="radio"] { + box-sizing: border-box; /* 1 */ + padding: 0; /* 2 */ +} + +/** + * 1. Address `appearance` set to `searchfield` in Safari 5 and Chrome. + * 2. Address `box-sizing` set to `border-box` in Safari 5 and Chrome + * (include `-moz` to future-proof). + */ + +input[type="search"] { + -webkit-appearance: textfield; /* 1 */ + -moz-box-sizing: content-box; + -webkit-box-sizing: content-box; /* 2 */ + box-sizing: content-box; +} + +/** + * Remove inner padding and search cancel button in Safari 5 and Chrome + * on OS X. + */ + +input[type="search"]::-webkit-search-cancel-button, +input[type="search"]::-webkit-search-decoration { + -webkit-appearance: none; +} + +/** + * Remove inner padding and border in Firefox 4+. + */ + +button::-moz-focus-inner, +input::-moz-focus-inner { + border: 0; + padding: 0; +} + +/** + * 1. Remove default vertical scrollbar in IE 8/9. + * 2. Improve readability and alignment in all browsers. + */ + +textarea { + overflow: auto; /* 1 */ + vertical-align: top; /* 2 */ +} + +/* ========================================================================== + Tables + ========================================================================== */ + +/** + * Remove most spacing between table cells. + */ + +table { + border-collapse: collapse; + border-spacing: 0; +} From 9b052d687322964724388b3c2dcfe446466ca45a Mon Sep 17 00:00:00 2001 From: Anik Brazeau <38330843+anikbrazeau@users.noreply.github.com> Date: Wed, 23 Oct 2024 13:02:00 -0400 Subject: [PATCH 022/440] Create syntax.css --- docs/assets/css/syntax.css | 60 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 60 insertions(+) create mode 100644 docs/assets/css/syntax.css diff --git a/docs/assets/css/syntax.css b/docs/assets/css/syntax.css new file mode 100644 index 00000000..2774b764 --- /dev/null +++ b/docs/assets/css/syntax.css @@ -0,0 +1,60 @@ +.highlight { background: #ffffff; } +.highlight .c { color: #999988; font-style: italic } /* Comment */ +.highlight .err { color: #a61717; background-color: #e3d2d2 } /* Error */ +.highlight .k { font-weight: bold } /* Keyword */ +.highlight .o { font-weight: bold } /* Operator */ +.highlight .cm { color: #999988; font-style: italic } /* Comment.Multiline */ +.highlight .cp { color: #999999; font-weight: bold } /* Comment.Preproc */ +.highlight .c1 { color: #999988; font-style: italic } /* Comment.Single */ +.highlight .cs { color: #999999; font-weight: bold; font-style: italic } /* Comment.Special */ +.highlight .gd { color: #000000; background-color: #ffdddd } /* Generic.Deleted */ +.highlight .gd .x { color: #000000; background-color: #ffaaaa } /* Generic.Deleted.Specific */ +.highlight .ge { font-style: italic } /* Generic.Emph */ +.highlight .gr { color: #aa0000 } /* Generic.Error */ +.highlight .gh { color: #999999 } /* Generic.Heading */ +.highlight .gi { color: #000000; background-color: #ddffdd } /* Generic.Inserted */ +.highlight .gi .x { color: #000000; background-color: #aaffaa } /* Generic.Inserted.Specific */ +.highlight .go { color: #888888 } /* Generic.Output */ +.highlight .gp { color: #555555 } /* Generic.Prompt */ +.highlight .gs { font-weight: bold } /* Generic.Strong */ +.highlight .gu { color: #aaaaaa } /* Generic.Subheading */ +.highlight .gt { color: #aa0000 } /* Generic.Traceback */ +.highlight .kc { font-weight: bold } /* Keyword.Constant */ +.highlight .kd { font-weight: bold } /* Keyword.Declaration */ +.highlight .kp { font-weight: bold } /* Keyword.Pseudo */ +.highlight .kr { font-weight: bold } /* Keyword.Reserved */ +.highlight .kt { color: #445588; font-weight: bold } /* Keyword.Type */ +.highlight .m { color: #009999 } /* Literal.Number */ +.highlight .s { color: #d14 } /* Literal.String */ +.highlight .na { color: #008080 } /* Name.Attribute */ +.highlight .nb { color: #0086B3 } /* Name.Builtin */ +.highlight .nc { color: #445588; font-weight: bold } /* Name.Class */ +.highlight .no { color: #008080 } /* Name.Constant */ +.highlight .ni { color: #800080 } /* Name.Entity */ +.highlight .ne { color: #990000; font-weight: bold } /* Name.Exception */ +.highlight .nf { color: #990000; font-weight: bold } /* Name.Function */ +.highlight .nn { color: #555555 } /* Name.Namespace */ +.highlight .nt { color: #000080 } /* Name.Tag */ +.highlight .nv { color: #008080 } /* Name.Variable */ +.highlight .ow { font-weight: bold } /* Operator.Word */ +.highlight .w { color: #bbbbbb } /* Text.Whitespace */ +.highlight .mf { color: #009999 } /* Literal.Number.Float */ +.highlight .mh { color: #009999 } /* Literal.Number.Hex */ +.highlight .mi { color: #009999 } /* Literal.Number.Integer */ +.highlight .mo { color: #009999 } /* Literal.Number.Oct */ +.highlight .sb { color: #d14 } /* Literal.String.Backtick */ +.highlight .sc { color: #d14 } /* Literal.String.Char */ +.highlight .sd { color: #d14 } /* Literal.String.Doc */ +.highlight .s2 { color: #d14 } /* Literal.String.Double */ +.highlight .se { color: #d14 } /* Literal.String.Escape */ +.highlight .sh { color: #d14 } /* Literal.String.Heredoc */ +.highlight .si { color: #d14 } /* Literal.String.Interpol */ +.highlight .sx { color: #d14 } /* Literal.String.Other */ +.highlight .sr { color: #009926 } /* Literal.String.Regex */ +.highlight .s1 { color: #d14 } /* Literal.String.Single */ +.highlight .ss { color: #990073 } /* Literal.String.Symbol */ +.highlight .bp { color: #999999 } /* Name.Builtin.Pseudo */ +.highlight .vc { color: #008080 } /* Name.Variable.Class */ +.highlight .vg { color: #008080 } /* Name.Variable.Global */ +.highlight .vi { color: #008080 } /* Name.Variable.Instance */ +.highlight .il { color: #009999 } /* Literal.Number.Integer.Long */ From 48285779bdfe969ff3af48b3ad99673a0bc3ed2e Mon Sep 17 00:00:00 2001 From: Anik Brazeau <38330843+anikbrazeau@users.noreply.github.com> Date: Wed, 23 Oct 2024 13:03:39 -0400 Subject: [PATCH 023/440] Create respond.min.js --- docs/assets/js/respond.min.js | 6 ++++++ 1 file changed, 6 insertions(+) create mode 100644 docs/assets/js/respond.min.js diff --git a/docs/assets/js/respond.min.js b/docs/assets/js/respond.min.js new file mode 100644 index 00000000..e3dc2c0d --- /dev/null +++ b/docs/assets/js/respond.min.js @@ -0,0 +1,6 @@ +/*! matchMedia() polyfill - Test a CSS media type/query in JS. Authors & copyright (c) 2012: Scott Jehl, Paul Irish, Nicholas Zakas. Dual MIT/BSD license */ +/*! NOTE: If you're already including a window.matchMedia polyfill via Modernizr or otherwise, you don't need this part */ +window.matchMedia=window.matchMedia||function(a){"use strict";var c,d=a.documentElement,e=d.firstElementChild||d.firstChild,f=a.createElement("body"),g=a.createElement("div");return g.id="mq-test-1",g.style.cssText="position:absolute;top:-100em",f.style.background="none",f.appendChild(g),function(a){return g.innerHTML='',d.insertBefore(f,e),c=42===g.offsetWidth,d.removeChild(f),{matches:c,media:a}}}(document); + +/*! Respond.js v1.3.0: min/max-width media query polyfill. (c) Scott Jehl. MIT/GPLv2 Lic. j.mp/respondjs */ +(function(a){"use strict";function x(){u(!0)}var b={};if(a.respond=b,b.update=function(){},b.mediaQueriesSupported=a.matchMedia&&a.matchMedia("only all").matches,!b.mediaQueriesSupported){var q,r,t,c=a.document,d=c.documentElement,e=[],f=[],g=[],h={},i=30,j=c.getElementsByTagName("head")[0]||d,k=c.getElementsByTagName("base")[0],l=j.getElementsByTagName("link"),m=[],n=function(){for(var b=0;l.length>b;b++){var c=l[b],d=c.href,e=c.media,f=c.rel&&"stylesheet"===c.rel.toLowerCase();d&&f&&!h[d]&&(c.styleSheet&&c.styleSheet.rawCssText?(p(c.styleSheet.rawCssText,d,e),h[d]=!0):(!/^([a-zA-Z:]*\/\/)/.test(d)&&!k||d.replace(RegExp.$1,"").split("/")[0]===a.location.host)&&m.push({href:d,media:e}))}o()},o=function(){if(m.length){var b=m.shift();v(b.href,function(c){p(c,b.href,b.media),h[b.href]=!0,a.setTimeout(function(){o()},0)})}},p=function(a,b,c){var d=a.match(/@media[^\{]+\{([^\{\}]*\{[^\}\{]*\})+/gi),g=d&&d.length||0;b=b.substring(0,b.lastIndexOf("/"));var h=function(a){return a.replace(/(url\()['"]?([^\/\)'"][^:\)'"]+)['"]?(\))/g,"$1"+b+"$2$3")},i=!g&&c;b.length&&(b+="/"),i&&(g=1);for(var j=0;g>j;j++){var k,l,m,n;i?(k=c,f.push(h(a))):(k=d[j].match(/@media *([^\{]+)\{([\S\s]+?)$/)&&RegExp.$1,f.push(RegExp.$2&&h(RegExp.$2))),m=k.split(","),n=m.length;for(var o=0;n>o;o++)l=m[o],e.push({media:l.split("(")[0].match(/(only\s+)?([a-zA-Z]+)\s?/)&&RegExp.$2||"all",rules:f.length-1,hasquery:l.indexOf("(")>-1,minw:l.match(/\(\s*min\-width\s*:\s*(\s*[0-9\.]+)(px|em)\s*\)/)&&parseFloat(RegExp.$1)+(RegExp.$2||""),maxw:l.match(/\(\s*max\-width\s*:\s*(\s*[0-9\.]+)(px|em)\s*\)/)&&parseFloat(RegExp.$1)+(RegExp.$2||"")})}u()},s=function(){var a,b=c.createElement("div"),e=c.body,f=!1;return b.style.cssText="position:absolute;font-size:1em;width:1em",e||(e=f=c.createElement("body"),e.style.background="none"),e.appendChild(b),d.insertBefore(e,d.firstChild),a=b.offsetWidth,f?d.removeChild(e):e.removeChild(b),a=t=parseFloat(a)},u=function(b){var h="clientWidth",k=d[h],m="CSS1Compat"===c.compatMode&&k||c.body[h]||k,n={},o=l[l.length-1],p=(new Date).getTime();if(b&&q&&i>p-q)return a.clearTimeout(r),r=a.setTimeout(u,i),void 0;q=p;for(var v in e)if(e.hasOwnProperty(v)){var w=e[v],x=w.minw,y=w.maxw,z=null===x,A=null===y,B="em";x&&(x=parseFloat(x)*(x.indexOf(B)>-1?t||s():1)),y&&(y=parseFloat(y)*(y.indexOf(B)>-1?t||s():1)),w.hasquery&&(z&&A||!(z||m>=x)||!(A||y>=m))||(n[w.media]||(n[w.media]=[]),n[w.media].push(f[w.rules]))}for(var C in g)g.hasOwnProperty(C)&&g[C]&&g[C].parentNode===j&&j.removeChild(g[C]);for(var D in n)if(n.hasOwnProperty(D)){var E=c.createElement("style"),F=n[D].join("\n");E.type="text/css",E.media=D,j.insertBefore(E,o.nextSibling),E.styleSheet?E.styleSheet.cssText=F:E.appendChild(c.createTextNode(F)),g.push(E)}},v=function(a,b){var c=w();c&&(c.open("GET",a,!0),c.onreadystatechange=function(){4!==c.readyState||200!==c.status&&304!==c.status||b(c.responseText)},4!==c.readyState&&c.send(null))},w=function(){var b=!1;try{b=new a.XMLHttpRequest}catch(c){b=new a.ActiveXObject("Microsoft.XMLHTTP")}return function(){return b}}();n(),b.update=n,a.addEventListener?a.addEventListener("resize",x,!1):a.attachEvent&&a.attachEvent("onresize",x)}})(this); From 73517f5b543810f253bb85c022af9db1c3ba0271 Mon Sep 17 00:00:00 2001 From: Anik Brazeau <38330843+anikbrazeau@users.noreply.github.com> Date: Wed, 23 Oct 2024 13:05:00 -0400 Subject: [PATCH 024/440] Create contex.md --- docs/_pages/en/contex.md | 1 + 1 file changed, 1 insertion(+) create mode 100644 docs/_pages/en/contex.md diff --git a/docs/_pages/en/contex.md b/docs/_pages/en/contex.md new file mode 100644 index 00000000..8b137891 --- /dev/null +++ b/docs/_pages/en/contex.md @@ -0,0 +1 @@ + From 47434755f51fe9455baf2bbb999bd2e93d9f7f78 Mon Sep 17 00:00:00 2001 From: Anik Brazeau <38330843+anikbrazeau@users.noreply.github.com> Date: Wed, 23 Oct 2024 13:05:21 -0400 Subject: [PATCH 025/440] Create contexte.md --- docs/_pages/fr/contexte.md | 1 + 1 file changed, 1 insertion(+) create mode 100644 docs/_pages/fr/contexte.md diff --git a/docs/_pages/fr/contexte.md b/docs/_pages/fr/contexte.md new file mode 100644 index 00000000..8b137891 --- /dev/null +++ b/docs/_pages/fr/contexte.md @@ -0,0 +1 @@ + From beae87ca80ca4b227526218c7ea869fe2e886157 Mon Sep 17 00:00:00 2001 From: Anik Brazeau <38330843+anikbrazeau@users.noreply.github.com> Date: Wed, 23 Oct 2024 13:06:22 -0400 Subject: [PATCH 026/440] Update default.html --- docs/_layouts/default.html | 77 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 77 insertions(+) diff --git a/docs/_layouts/default.html b/docs/_layouts/default.html index 8b137891..5c2ddfba 100644 --- a/docs/_layouts/default.html +++ b/docs/_layouts/default.html @@ -1 +1,78 @@ + + +
+ + +{{ repo.description }}
+ +{{site.data.translations[page.lang].learn-more}} {{site.data.translations[page.lang].code-and-repo}}.
From c1d04448b0cbe5b5c6ab7396e837a9052957280d Mon Sep 17 00:00:00 2001 From: Anik Brazeau <38330843+anikbrazeau@users.noreply.github.com> Date: Wed, 23 Oct 2024 13:43:18 -0400 Subject: [PATCH 054/440] Update page.html --- docs/_layouts/page.html | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/_layouts/page.html b/docs/_layouts/page.html index e5222ed7..a467fbbc 100644 --- a/docs/_layouts/page.html +++ b/docs/_layouts/page.html @@ -1,7 +1,6 @@ --- layout: default --- - +← {{site.data.translations[page.lang].toc}}
gDg!C{15}AMjc(W!}){Bon&eB
zJ~zG%YD5~yi8u1gNPlTg<3H5jD$a(tS)1gbl{&p7Ri57HN&a7z!D%ziif#tEKu_9R
zK%CqJTb(YF|1XXgB_0Mf#i_1H1qJ-WAWrQxCI7E35jO46W|i>_>J;lE3IV*$`b*N`
zZ8lP#ye!tg?Yhm%kN;<*?R#H&?>K%t$b0Z~d{CD@DZD$gkY5|Q)8)g*JDfj!EaEkW
z=khvpb9pUIaY4hUA_LyJ?dy5rE4Q6DzR%~kUm2-LSw2{r0dKR@Rk85ePF2SJ`2O8m
z4wML_c>q@s;8U_uG%*>)#fwML+UgUuUHj3ut5=V{T)XDl%S{_T`PO0M7~0xR;JWow
zxPIep+`Rb?x;Rf^ZDA?@Y+VwZ(x;H6zG2Mg6lhZ_p;fMd7Kw~}SPxAy1wGTi(TaRf
zrImS^m|XsT(V{E3WXV-rw)9h6w)|6EzG4h5SKdIIRo8Ki?MUi-c>Pw#q2s)t@(5gb;OK&MIpEm9>Iw8hY;&7o&%Xpw25S*!p>`XOkP
zs-dey4ebi)CeD7tEfbTgXl`y~FJCc=D=n{~jm>pjy=Dy8uDy 35Qk6Sh#g`
z5lN)sfC{C+s0EXZtHn}drj#MWMMq&*8kh)y3WNcyL6xP}F%2x-TV5uzx0#7J>{}N&
zlZE>uDTyc^%Yn2YmQJ9CN=algHY|)lrqRQ~$RSt?iA*7qkT)!pOk>i+n3Qnry9b9v
z)5_$`L@xhbEab$(DPUN`Bog&{JwZ<;K-zR7nZaP#I4G1*#3NLftA+tXs9J}gVc>!~
zsaC0hm5>^1V+7KmY?y^ZGX0|jmF7LITKBF^NW+K*Ktm)GNVbw@97Ur4@2XP0_twFQ
z;Gg;aPhy=oR|66gK^>H>l_GL7^PB2)S&rp=<0=robz~t987=
zJHPRV$H3lYd&FD4xa+G65|cf7#Gp%FjvfoxTwYfZ?oJ>EH|4&ddB-Rx?PpGKoH?Za
zc;kv>z^%z?+lhpzt~bTsxO6vCKTX&7^hW0Nw{6Igr#~65jMV>~HQ8`$1g209-MV%*
z>zAR_$Wq5Z?~JV{t2~FN`+8r6hB$9$wpgwgQY^yV=%CooZuhk5o_+IEfb*B7g9nN^
zmn?sak5Y^MvF#;++A2nT`6%h~)oOw{**Z`-d87Shl>N=^2dZ($;)nX>M`%Gz=N9*d
zH@gq}j}{&;%PTl|*7!kwv|~$tVA8S5`%TJr<*oS+tUPoJT(JF>ovP@jMW(>)M {{site.data.translations[page.lang].built-by}} {{ site.data.translations[page.lang].cds-snc}}. {{site.data.translations[page.lang].contribute}}. {{site.data.translations[page.lang].hosting}} GitHub Pages.<;Yea~zQyC6G~oAJ}mIwBqRr
zhl#v`M*)W{{ site
Table of contents
-{% assign mydocs = site.pages | where:"lang","en" | where:"layout","page" | group_by: 'category' | sort: 'name' %}
-{% for cat in mydocs %}
-{{ cat.name | capitalize }}
-
- {% assign items = cat.items | sort: 'title' %}
- {% for item in items %}
-
-{% endfor %}
From 5864171a54dab621b168c2c72b249a8d31a43ed7 Mon Sep 17 00:00:00 2001
From: Anik Brazeau <38330843+anikbrazeau@users.noreply.github.com>
Date: Wed, 23 Oct 2024 16:23:19 -0400
Subject: [PATCH 087/440] Delete docs/_includes/navigation-fr.html
---
docs/_includes/navigation-fr.html | 11 -----------
1 file changed, 11 deletions(-)
delete mode 100644 docs/_includes/navigation-fr.html
diff --git a/docs/_includes/navigation-fr.html b/docs/_includes/navigation-fr.html
deleted file mode 100644
index 1beb8e27..00000000
--- a/docs/_includes/navigation-fr.html
+++ /dev/null
@@ -1,11 +0,0 @@
-Table des matières
-{% assign mydocs = site.pages | where:"lang","fr" | where:"layout","page" | group_by: 'category' | sort: 'name' %}
-{% for cat in mydocs %}
-{{ cat.name | capitalize }}
-
- {% assign items = cat.items | sort: 'title' %}
- {% for item in items %}
-
-{% endfor %}
From 20db542d2995818492c00eea6540f3063d721086 Mon Sep 17 00:00:00 2001
From: Anik Brazeau <38330843+anikbrazeau@users.noreply.github.com>
Date: Wed, 23 Oct 2024 16:23:29 -0400
Subject: [PATCH 088/440] Delete docs/_includes/home.md
---
docs/_includes/home.md | 1 -
1 file changed, 1 deletion(-)
delete mode 100644 docs/_includes/home.md
diff --git a/docs/_includes/home.md b/docs/_includes/home.md
deleted file mode 100644
index 7f93ab9a..00000000
--- a/docs/_includes/home.md
+++ /dev/null
@@ -1 +0,0 @@
-Placeholder text
From 83a7f1d800332cb5a85ea7adacb4f75d97e8aab5 Mon Sep 17 00:00:00 2001
From: Anik Brazeau <38330843+anikbrazeau@users.noreply.github.com>
Date: Wed, 23 Oct 2024 16:23:37 -0400
Subject: [PATCH 089/440] Delete docs/_includes/getting-started.md
---
docs/_includes/getting-started.md | 1 -
1 file changed, 1 deletion(-)
delete mode 100644 docs/_includes/getting-started.md
diff --git a/docs/_includes/getting-started.md b/docs/_includes/getting-started.md
deleted file mode 100644
index e5d12073..00000000
--- a/docs/_includes/getting-started.md
+++ /dev/null
@@ -1 +0,0 @@
-Getting started
From adb79b8e8913ac084eb5d69fda0eebba644964ce Mon Sep 17 00:00:00 2001
From: Anik Brazeau <38330843+anikbrazeau@users.noreply.github.com>
Date: Wed, 23 Oct 2024 16:25:20 -0400
Subject: [PATCH 090/440] Update getting-started.md
---
docs/_pages/en/getting-started.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/_pages/en/getting-started.md b/docs/_pages/en/getting-started.md
index 5df09997..9bc2b3d9 100644
--- a/docs/_pages/en/getting-started.md
+++ b/docs/_pages/en/getting-started.md
@@ -1 +1 @@
-Page 2
+GETTING STARTED
From bc41e8ac06954ea818178937280f65d27c657de8 Mon Sep 17 00:00:00 2001
From: Anik Brazeau <38330843+anikbrazeau@users.noreply.github.com>
Date: Wed, 23 Oct 2024 16:26:12 -0400
Subject: [PATCH 091/440] Update main.css
---
docs/assets/css/main.css | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/docs/assets/css/main.css b/docs/assets/css/main.css
index 4de1ff15..d437920c 100644
--- a/docs/assets/css/main.css
+++ b/docs/assets/css/main.css
@@ -35,7 +35,7 @@ Typography
*/
body {
- font-family: "Noto Sans", Noto Sans, sans-serif;
+ font-family: "Noto Sans", sans-serif;
font-weight: 400;
font-style: normal;
line-height: 1.466666667;
@@ -46,13 +46,13 @@ h3,
h4,
h5,
strong {
- font-family: "Noto Sans", "Noto Sans", Noto Sans, sans-serif;
+ font-family: "Noto Sans", sans-serif;
font-weight: 600;
}
.site-title {
font-size: 1.625em;
- font-family: "Noto Sans", Noto Sans, sans-serif;
+ font-family: "Noto Sans", sans-serif;
font-weight: normal;
color: vc;
margin: 0;
From 1d08f9405092d947d7219feb3194a0da8f46c490 Mon Sep 17 00:00:00 2001
From: Anik Brazeau <38330843+anikbrazeau@users.noreply.github.com>
Date: Wed, 23 Oct 2024 16:27:39 -0400
Subject: [PATCH 092/440] Update main.css
---
docs/assets/css/main.css | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/docs/assets/css/main.css b/docs/assets/css/main.css
index d437920c..11f28bf1 100644
--- a/docs/assets/css/main.css
+++ b/docs/assets/css/main.css
@@ -46,13 +46,13 @@ h3,
h4,
h5,
strong {
- font-family: "Noto Sans", sans-serif;
+ font-family: "Noto Sans";
font-weight: 600;
}
.site-title {
font-size: 1.625em;
- font-family: "Noto Sans", sans-serif;
+ font-family: "Noto Sans";
font-weight: normal;
color: vc;
margin: 0;
From 925ea04555783db9a061e7436c5435548672a09d Mon Sep 17 00:00:00 2001
From: Anik Brazeau <38330843+anikbrazeau@users.noreply.github.com>
Date: Wed, 23 Oct 2024 16:28:50 -0400
Subject: [PATCH 093/440] Update main.css
---
docs/assets/css/main.css | 2 ++
1 file changed, 2 insertions(+)
diff --git a/docs/assets/css/main.css b/docs/assets/css/main.css
index 11f28bf1..1a85a3a8 100644
--- a/docs/assets/css/main.css
+++ b/docs/assets/css/main.css
@@ -12,6 +12,8 @@ Normalize the box model
==================================
*/
+
+
*,
*:before,
*:after {
From 4a03393d333822b5e5a20868a7b41213d697a99f Mon Sep 17 00:00:00 2001
From: Anik Brazeau <38330843+anikbrazeau@users.noreply.github.com>
Date: Wed, 23 Oct 2024 16:29:13 -0400
Subject: [PATCH 094/440] Update main.css
---
docs/assets/css/main.css | 3 +--
1 file changed, 1 insertion(+), 2 deletions(-)
diff --git a/docs/assets/css/main.css b/docs/assets/css/main.css
index 1a85a3a8..6531bf70 100644
--- a/docs/assets/css/main.css
+++ b/docs/assets/css/main.css
@@ -12,8 +12,6 @@ Normalize the box model
==================================
*/
-
-
*,
*:before,
*:after {
@@ -35,6 +33,7 @@ html, body {
Typography
==================================
*/
+
body {
font-family: "Noto Sans", sans-serif;
From 6a0703297821ba5700008de45b02be837c354ab0 Mon Sep 17 00:00:00 2001
From: Anik Brazeau <38330843+anikbrazeau@users.noreply.github.com>
Date: Wed, 23 Oct 2024 16:30:09 -0400
Subject: [PATCH 095/440] Update main.css
---
docs/assets/css/main.css | 1 -
1 file changed, 1 deletion(-)
diff --git a/docs/assets/css/main.css b/docs/assets/css/main.css
index 6531bf70..11f28bf1 100644
--- a/docs/assets/css/main.css
+++ b/docs/assets/css/main.css
@@ -33,7 +33,6 @@ html, body {
Typography
==================================
*/
-
body {
font-family: "Noto Sans", sans-serif;
From f361a2aa1f977b8abe23c27958df86f40d62bd90 Mon Sep 17 00:00:00 2001
From: Anik Brazeau <38330843+anikbrazeau@users.noreply.github.com>
Date: Wed, 23 Oct 2024 16:33:39 -0400
Subject: [PATCH 096/440] Update style.scss
---
docs/assets/css/style.scss | 11 +++++++++++
1 file changed, 11 insertions(+)
diff --git a/docs/assets/css/style.scss b/docs/assets/css/style.scss
index 5742f930..9ef426e2 100644
--- a/docs/assets/css/style.scss
+++ b/docs/assets/css/style.scss
@@ -2,3 +2,14 @@
---
@import "{{ site.theme }}";
+
+
+
+
From 4fbb000dbcbd458df7fb8200099ce0455c15c2e3 Mon Sep 17 00:00:00 2001
From: Anik Brazeau <38330843+anikbrazeau@users.noreply.github.com>
Date: Wed, 23 Oct 2024 16:34:36 -0400
Subject: [PATCH 097/440] Create head-custom-google-analytics.html
---
docs/_includes/head-custom-google-analytics.html | 1 +
1 file changed, 1 insertion(+)
create mode 100644 docs/_includes/head-custom-google-analytics.html
diff --git a/docs/_includes/head-custom-google-analytics.html b/docs/_includes/head-custom-google-analytics.html
new file mode 100644
index 00000000..8b137891
--- /dev/null
+++ b/docs/_includes/head-custom-google-analytics.html
@@ -0,0 +1 @@
+
From d1568071c700428cd2eec6aa72c4e4f7ddf74326 Mon Sep 17 00:00:00 2001
From: Anik Brazeau <38330843+anikbrazeau@users.noreply.github.com>
Date: Wed, 23 Oct 2024 16:35:14 -0400
Subject: [PATCH 098/440] Update head-custom-google-analytics.html
---
docs/_includes/head-custom-google-analytics.html | 11 ++++++++++-
1 file changed, 10 insertions(+), 1 deletion(-)
diff --git a/docs/_includes/head-custom-google-analytics.html b/docs/_includes/head-custom-google-analytics.html
index 8b137891..8a3ae5c9 100644
--- a/docs/_includes/head-custom-google-analytics.html
+++ b/docs/_includes/head-custom-google-analytics.html
@@ -1 +1,10 @@
-
+{% if site.google_analytics %}
+
+{% endif %}
From e5d8909c40f988266ba63ee55da533f16940cb86 Mon Sep 17 00:00:00 2001
From: Anik Brazeau <38330843+anikbrazeau@users.noreply.github.com>
Date: Wed, 23 Oct 2024 16:35:40 -0400
Subject: [PATCH 099/440] Create head-custom.html
---
docs/_includes/head-custom.html | 9 +++++++++
1 file changed, 9 insertions(+)
create mode 100644 docs/_includes/head-custom.html
diff --git a/docs/_includes/head-custom.html b/docs/_includes/head-custom.html
new file mode 100644
index 00000000..f7187e79
--- /dev/null
+++ b/docs/_includes/head-custom.html
@@ -0,0 +1,9 @@
+
+
+
+{% include head-custom-google-analytics.html %}
+
+
+
+
+
From d5423fbf2ba0f6237a91028d0698cb9c273c9652 Mon Sep 17 00:00:00 2001
From: Anik Brazeau <38330843+anikbrazeau@users.noreply.github.com>
Date: Wed, 23 Oct 2024 16:38:09 -0400
Subject: [PATCH 100/440] Update index.html
---
docs/index.html | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/index.html b/docs/index.html
index 397e76c7..f5ecf87a 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -1,7 +1,7 @@
---
layout: default
lang: en
-trans_url: /fr
+trans_url: /accueil
---
{% capture index %}{% include index.md %}{% endcapture %}
From 4c71d5ae4c9a322f491c00f756e2a4954fc80753 Mon Sep 17 00:00:00 2001
From: Anik Brazeau <38330843+anikbrazeau@users.noreply.github.com>
Date: Wed, 23 Oct 2024 16:40:12 -0400
Subject: [PATCH 101/440] Update _config.yml
---
docs/_config.yml | 12 ++++--------
1 file changed, 4 insertions(+), 8 deletions(-)
diff --git a/docs/_config.yml b/docs/_config.yml
index d1bcbb99..81e7ce7e 100644
--- a/docs/_config.yml
+++ b/docs/_config.yml
@@ -1,11 +1,7 @@
+# Base configuration
remote_theme: pages-themes/minimal@v0.2.0
plugins:
- jekyll-remote-theme # add this line to the plugins list if you already have one
-title: GC Forms API Documentation
-description: 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.
-
-
-# Base configuration
exclude: [".rvmrc", ".rbenv-version", "README.md", "Rakefile", "changelog.md"]
markdown: kramdown
highlighter: rouge
@@ -16,15 +12,15 @@ collections:
permalink: /:path/
# Title
-name: GC Forms API Documentation
-subtitle: How to retrieve form submissions from an API endpoint
+title: GC Forms API Documentation
+description: 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: '/cds-snc/forms-api'
+baseurl: 'forms-api/docs'
# Author/Organization info to be displayed in the templates
author:
From 2e3c0d00f80e9f631ac1ced5eb19b49d7e4619bd Mon Sep 17 00:00:00 2001
From: Anik Brazeau <38330843+anikbrazeau@users.noreply.github.com>
Date: Wed, 23 Oct 2024 16:41:23 -0400
Subject: [PATCH 102/440] Delete docs/assets/img/1
---
docs/assets/img/1 | 1 -
1 file changed, 1 deletion(-)
delete mode 100644 docs/assets/img/1
diff --git a/docs/assets/img/1 b/docs/assets/img/1
deleted file mode 100644
index d00491fd..00000000
--- a/docs/assets/img/1
+++ /dev/null
@@ -1 +0,0 @@
-1
From f980848e56e4dc235ab4a7b49a5ce3513493ee53 Mon Sep 17 00:00:00 2001
From: Anik Brazeau <38330843+anikbrazeau@users.noreply.github.com>
Date: Wed, 23 Oct 2024 16:41:52 -0400
Subject: [PATCH 103/440] Update main.css
---
docs/assets/css/main.css | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/docs/assets/css/main.css b/docs/assets/css/main.css
index 11f28bf1..bfa5968c 100644
--- a/docs/assets/css/main.css
+++ b/docs/assets/css/main.css
@@ -35,7 +35,7 @@ Typography
*/
body {
- font-family: "Noto Sans", sans-serif;
+ font-family: "Arial", sans-serif;
font-weight: 400;
font-style: normal;
line-height: 1.466666667;
@@ -46,13 +46,13 @@ h3,
h4,
h5,
strong {
- font-family: "Noto Sans";
+ font-family: "Arial";
font-weight: 600;
}
.site-title {
font-size: 1.625em;
- font-family: "Noto Sans";
+ font-family: "Arial";
font-weight: normal;
color: vc;
margin: 0;
From 015e8dd8bfc76991d92fc9ac18d3b49bdd607d14 Mon Sep 17 00:00:00 2001
From: Anik Brazeau <38330843+anikbrazeau@users.noreply.github.com>
Date: Wed, 23 Oct 2024 16:43:54 -0400
Subject: [PATCH 104/440] Update _config.yml
---
docs/_config.yml | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/_config.yml b/docs/_config.yml
index 81e7ce7e..d7d1e4d2 100644
--- a/docs/_config.yml
+++ b/docs/_config.yml
@@ -20,7 +20,7 @@ description: This documentation is for developers who want to use the GC Forms A
# 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/docs'
+baseurl: '/forms-api'
# Author/Organization info to be displayed in the templates
author:
From b8e49aca9d41162c5084e76e77c4c8917e583c7d Mon Sep 17 00:00:00 2001
From: Anik Brazeau <38330843+anikbrazeau@users.noreply.github.com>
Date: Wed, 23 Oct 2024 16:46:43 -0400
Subject: [PATCH 105/440] Delete
docs/_includes/head-custom-google-analytics.html
---
docs/_includes/head-custom-google-analytics.html | 10 ----------
1 file changed, 10 deletions(-)
delete mode 100644 docs/_includes/head-custom-google-analytics.html
diff --git a/docs/_includes/head-custom-google-analytics.html b/docs/_includes/head-custom-google-analytics.html
deleted file mode 100644
index 8a3ae5c9..00000000
--- a/docs/_includes/head-custom-google-analytics.html
+++ /dev/null
@@ -1,10 +0,0 @@
-{% if site.google_analytics %}
-
-{% endif %}
From 5f9257ce012d55b14af1238f6393f2e62597e8b9 Mon Sep 17 00:00:00 2001
From: Anik Brazeau <38330843+anikbrazeau@users.noreply.github.com>
Date: Wed, 23 Oct 2024 16:46:51 -0400
Subject: [PATCH 106/440] Delete docs/_includes/head-custom.html
---
docs/_includes/head-custom.html | 9 ---------
1 file changed, 9 deletions(-)
delete mode 100644 docs/_includes/head-custom.html
diff --git a/docs/_includes/head-custom.html b/docs/_includes/head-custom.html
deleted file mode 100644
index f7187e79..00000000
--- a/docs/_includes/head-custom.html
+++ /dev/null
@@ -1,9 +0,0 @@
-
-
-
-{% include head-custom-google-analytics.html %}
-
-
-
-
-
From 0d8b465641d0e4487bbd7812b26b5fe87d9fc73e Mon Sep 17 00:00:00 2001
From: Anik Brazeau <38330843+anikbrazeau@users.noreply.github.com>
Date: Wed, 23 Oct 2024 16:47:56 -0400
Subject: [PATCH 107/440] Update main.css
---
docs/assets/css/main.css | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/docs/assets/css/main.css b/docs/assets/css/main.css
index bfa5968c..3330ca9c 100644
--- a/docs/assets/css/main.css
+++ b/docs/assets/css/main.css
@@ -35,7 +35,7 @@ Typography
*/
body {
- font-family: "Arial", sans-serif;
+ font-family: "Avenir Next", Arial, sans-serif;
font-weight: 400;
font-style: normal;
line-height: 1.466666667;
@@ -46,13 +46,13 @@ h3,
h4,
h5,
strong {
- font-family: "Arial";
+ font-family: "Avenir Next Demi", "Avenir Next", Arial, sans-serif;
font-weight: 600;
}
.site-title {
font-size: 1.625em;
- font-family: "Arial";
+ font-family: "Avenir Next", Arial, sans-serif;
font-weight: normal;
color: vc;
margin: 0;
From 08335aec44f35f1b8be69b60b2006fb7dd33e59c Mon Sep 17 00:00:00 2001
From: Anik Brazeau <38330843+anikbrazeau@users.noreply.github.com>
Date: Wed, 23 Oct 2024 16:48:29 -0400
Subject: [PATCH 108/440] Update menu.yml
---
docs/_data/menu.yml | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/docs/_data/menu.yml b/docs/_data/menu.yml
index cfbe4e21..cb010077 100644
--- a/docs/_data/menu.yml
+++ b/docs/_data/menu.yml
@@ -1,7 +1,7 @@
en:
home:
name: "Home"
- url: "/"
+ url: "/home/"
getting-started:
name: "Getting started"
url: "/getting-started/"
@@ -21,7 +21,7 @@ en:
fr:
accueil:
name: "Accueil"
- url: "/fr"
+ url: "/accueil/"
getting-started:
name: "Pour commencer"
url: "/pour-commencer/"
From 8352e29ce4e665cb8d187cc22ffc7ba607c3dfb3 Mon Sep 17 00:00:00 2001
From: Anik Brazeau <38330843+anikbrazeau@users.noreply.github.com>
Date: Wed, 23 Oct 2024 16:49:00 -0400
Subject: [PATCH 109/440] Update repos.yml
---
docs/_data/repos.yml | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)
diff --git a/docs/_data/repos.yml b/docs/_data/repos.yml
index e9c9f6e5..1123fa60 100644
--- a/docs/_data/repos.yml
+++ b/docs/_data/repos.yml
@@ -1,8 +1,8 @@
en:
-- name:
+- name: GC Forms API
description:
- url:
+ url: https://github.com/cds-snc/forms-api/
fr:
-- name:
+- name: API Formulaires GC
description:
- url:
+ url: https://github.com/cds-snc/forms-api/
From 00b1a17264056a9ce129a1feec3f41c745b82054 Mon Sep 17 00:00:00 2001
From: Anik Brazeau <38330843+anikbrazeau@users.noreply.github.com>
Date: Wed, 23 Oct 2024 16:50:24 -0400
Subject: [PATCH 110/440] Update _config.yml
---
docs/_config.yml | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/_config.yml b/docs/_config.yml
index d7d1e4d2..dbad0b63 100644
--- a/docs/_config.yml
+++ b/docs/_config.yml
@@ -20,7 +20,7 @@ description: This documentation is for developers who want to use the GC Forms A
# 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'
+baseurl: '/forms-api/docs'
# Author/Organization info to be displayed in the templates
author:
From 3af4ebdc4ecbbd7268a9c5f997067cdd4f0876c8 Mon Sep 17 00:00:00 2001
From: Anik Brazeau <38330843+anikbrazeau@users.noreply.github.com>
Date: Wed, 23 Oct 2024 16:54:27 -0400
Subject: [PATCH 111/440] Update index.html
---
docs/index.html | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/index.html b/docs/index.html
index f5ecf87a..1c88332c 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -3,6 +3,6 @@
lang: en
trans_url: /accueil
---
-
+{% include navigation.html %}
{% capture index %}{% include index.md %}{% endcapture %}
{{ index | markdownify }}
From f37a7d9f69b0c7a3b3be57f673416f30ef67d4fd Mon Sep 17 00:00:00 2001
From: Anik Brazeau <38330843+anikbrazeau@users.noreply.github.com>
Date: Wed, 23 Oct 2024 16:56:44 -0400
Subject: [PATCH 112/440] Update _config.yml
---
docs/_config.yml | 17 +++++++++++------
1 file changed, 11 insertions(+), 6 deletions(-)
diff --git a/docs/_config.yml b/docs/_config.yml
index dbad0b63..8972d958 100644
--- a/docs/_config.yml
+++ b/docs/_config.yml
@@ -1,7 +1,4 @@
# Base configuration
-remote_theme: pages-themes/minimal@v0.2.0
-plugins:
-- jekyll-remote-theme # add this line to the plugins list if you already have one
exclude: [".rvmrc", ".rbenv-version", "README.md", "Rakefile", "changelog.md"]
markdown: kramdown
highlighter: rouge
@@ -11,21 +8,29 @@ collections:
output: true
permalink: /:path/
+# Theme
+remote_theme: pages-themes/minimal@v0.2.0
+plugins:
+- jekyll-remote-theme # add this line to the plugins list if you already have one
+
# Title
-title: GC Forms API Documentation
-description: 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.
+name: GC Forms API Documentation
+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/docs'
+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:
From af629bc4d64ff36791e5188b78fdaabeb0d01019 Mon Sep 17 00:00:00 2001
From: Anik Brazeau <38330843+anikbrazeau@users.noreply.github.com>
Date: Wed, 23 Oct 2024 16:57:55 -0400
Subject: [PATCH 113/440] Update Gemfile
---
docs/Gemfile | 1 +
1 file changed, 1 insertion(+)
diff --git a/docs/Gemfile b/docs/Gemfile
index 75d9835f..0c8671cd 100644
--- a/docs/Gemfile
+++ b/docs/Gemfile
@@ -1,2 +1,3 @@
source "https://rubygems.org"
+
gem "github-pages", group: :jekyll_plugins
From bbd11c099436f44a2544cf4204563c70601130a7 Mon Sep 17 00:00:00 2001
From: Anik Brazeau <38330843+anikbrazeau@users.noreply.github.com>
Date: Wed, 23 Oct 2024 17:01:23 -0400
Subject: [PATCH 114/440] Update main.css
---
docs/assets/css/main.css | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/assets/css/main.css b/docs/assets/css/main.css
index 3330ca9c..bc3d6f1f 100644
--- a/docs/assets/css/main.css
+++ b/docs/assets/css/main.css
@@ -347,7 +347,7 @@ li h4 {
}
.license {
- font-family: "Noto Sans", Noto Sans, sans-serif;
+ font-family: "Avenir Next Demi", Arial, sans-serif;
font-weight: normal;
font-style: normal;
}
From d2be838d3b097d464e24edb195bed727f5248685 Mon Sep 17 00:00:00 2001
From: Anik Brazeau <38330843+anikbrazeau@users.noreply.github.com>
Date: Wed, 23 Oct 2024 17:02:12 -0400
Subject: [PATCH 115/440] Update style.scss
---
docs/assets/css/style.scss | 11 -----------
1 file changed, 11 deletions(-)
diff --git a/docs/assets/css/style.scss b/docs/assets/css/style.scss
index 9ef426e2..5742f930 100644
--- a/docs/assets/css/style.scss
+++ b/docs/assets/css/style.scss
@@ -2,14 +2,3 @@
---
@import "{{ site.theme }}";
-
-
-
-
From 6064978c8397a2aa2ff94b33e43153e45bd82be1 Mon Sep 17 00:00:00 2001
From: Anik Brazeau <38330843+anikbrazeau@users.noreply.github.com>
Date: Wed, 23 Oct 2024 17:05:26 -0400
Subject: [PATCH 116/440] Create navigation-fr.html
---
docs/_includes/navigation-fr.html | 11 +++++++++++
1 file changed, 11 insertions(+)
create mode 100644 docs/_includes/navigation-fr.html
diff --git a/docs/_includes/navigation-fr.html b/docs/_includes/navigation-fr.html
new file mode 100644
index 00000000..1beb8e27
--- /dev/null
+++ b/docs/_includes/navigation-fr.html
@@ -0,0 +1,11 @@
+Table des matières
+{% assign mydocs = site.pages | where:"lang","fr" | where:"layout","page" | group_by: 'category' | sort: 'name' %}
+{% for cat in mydocs %}
+{{ cat.name | capitalize }}
+
+ {% assign items = cat.items | sort: 'title' %}
+ {% for item in items %}
+
+{% endfor %}
From e479fd0e07e518d47723d70433a42afa8ab9589b Mon Sep 17 00:00:00 2001
From: Anik Brazeau <38330843+anikbrazeau@users.noreply.github.com>
Date: Wed, 23 Oct 2024 17:05:44 -0400
Subject: [PATCH 117/440] Create navigation.html
---
docs/_includes/navigation.html | 11 +++++++++++
1 file changed, 11 insertions(+)
create mode 100644 docs/_includes/navigation.html
diff --git a/docs/_includes/navigation.html b/docs/_includes/navigation.html
new file mode 100644
index 00000000..883f61a7
--- /dev/null
+++ b/docs/_includes/navigation.html
@@ -0,0 +1,11 @@
+Table of contents
+{% assign mydocs = site.pages | where:"lang","en" | where:"layout","page" | group_by: 'category' | sort: 'name' %}
+{% for cat in mydocs %}
+{{ cat.name | capitalize }}
+
+ {% assign items = cat.items | sort: 'title' %}
+ {% for item in items %}
+
+{% endfor %}
From 36d9f76254b635ba27d64f38510c54c41036aeee Mon Sep 17 00:00:00 2001
From: Anik Brazeau <38330843+anikbrazeau@users.noreply.github.com>
Date: Wed, 23 Oct 2024 17:06:35 -0400
Subject: [PATCH 118/440] Create accueil.md
---
docs/_includes/accueil.md | 1 +
1 file changed, 1 insertion(+)
create mode 100644 docs/_includes/accueil.md
diff --git a/docs/_includes/accueil.md b/docs/_includes/accueil.md
new file mode 100644
index 00000000..391a4f74
--- /dev/null
+++ b/docs/_includes/accueil.md
@@ -0,0 +1 @@
+# Accueil
From 7bc8cf4fc6b93d06515806d39711aa69e8bf90db Mon Sep 17 00:00:00 2001
From: Anik Brazeau <38330843+anikbrazeau@users.noreply.github.com>
Date: Wed, 23 Oct 2024 17:07:18 -0400
Subject: [PATCH 119/440] Update _config.yml
---
docs/_config.yml | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/_config.yml b/docs/_config.yml
index 8972d958..e928d95a 100644
--- a/docs/_config.yml
+++ b/docs/_config.yml
@@ -14,7 +14,7 @@ plugins:
- jekyll-remote-theme # add this line to the plugins list if you already have one
# Title
-name: GC Forms API Documentation
+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'
From 4c750f898f110911543925b9678d39b1a967b4b7 Mon Sep 17 00:00:00 2001
From: Anik Brazeau <38330843+anikbrazeau@users.noreply.github.com>
Date: Wed, 23 Oct 2024 17:10:58 -0400
Subject: [PATCH 120/440] Update translations.yml
---
docs/_data/translations.yml | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)
diff --git a/docs/_data/translations.yml b/docs/_data/translations.yml
index 062ff700..44c939a4 100644
--- a/docs/_data/translations.yml
+++ b/docs/_data/translations.yml
@@ -1,5 +1,5 @@
en:
- homepage-tag-line: "Technical documentation"
+ homepage-tag-line: ""
cds-snc: "GC Forms"
cds-snc-url: "https://articles.alpha.canada.ca/forms-formulaires/"
built-by: "This documentation was built for developers using"
@@ -7,9 +7,9 @@ en:
repo: "Repository"
language: "Français"
homepage-slug: "/home/"
- site-name: "API Documentation - GC Forms"
+ site-name: "GC Forms API"
fr:
- homepage-tag-line: "Documentation technique"
+ homepage-tag-line: ""
cds-snc: "Formulaires GC"
cds-snc-url: "https://articles.alpha.canada.ca/forms-formulaires/fr/"
built-by: "Cette documentation a été conçue pour les développeurs qui utilisent"
@@ -17,4 +17,4 @@ fr:
repo: "Référentiel"
language: "English"
homepage-slug: "/accueil/"
- site-name: "Documentation API - Formulaires GC"
+ site-name: "API Formulaires GC"
From adc8c6f75b22add9c329abc7016f9ce8b4bf96d6 Mon Sep 17 00:00:00 2001
From: Anik Brazeau <38330843+anikbrazeau@users.noreply.github.com>
Date: Wed, 23 Oct 2024 17:12:19 -0400
Subject: [PATCH 121/440] Update index.md
---
docs/_includes/index.md | 6 +-----
1 file changed, 1 insertion(+), 5 deletions(-)
diff --git a/docs/_includes/index.md b/docs/_includes/index.md
index 39fd6e93..a299cce5 100644
--- a/docs/_includes/index.md
+++ b/docs/_includes/index.md
@@ -1,5 +1 @@
-## Welcome
-
-Welcome to the first iteration of the GC Forms application programming interface (API) and its technical documentation. This lite version of 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.
-
-Our goal is to guide you through setting up an initial integration and securely retrieving form submissions, while also being able to learn from you in the process (for example: what’s challenging or what’s confusing) and then integrate your feedback into our upcoming iterations. We appreciate your patience as we continue to fill in the gaps and iron out issues along the way. Your open and honest feedback will help us improve GC Forms and shape the future of this product.
+{% include home.md %}
From 2cfa491c4fb0f8dbe2e8f9a76c59d59d79cdc155 Mon Sep 17 00:00:00 2001
From: Anik Brazeau <38330843+anikbrazeau@users.noreply.github.com>
Date: Wed, 23 Oct 2024 17:12:58 -0400
Subject: [PATCH 122/440] Create home.md
---
docs/_includes/home.md | 5 +++++
1 file changed, 5 insertions(+)
create mode 100644 docs/_includes/home.md
diff --git a/docs/_includes/home.md b/docs/_includes/home.md
new file mode 100644
index 00000000..d88dfeae
--- /dev/null
+++ b/docs/_includes/home.md
@@ -0,0 +1,5 @@
+# Welcome
+
+Welcome to the first iteration of the GC Forms application programming interface (API) and its technical documentation. This lite version of 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.
+
+Our goal is to guide you through setting up an initial integration and securely retrieving form submissions, while also being able to learn from you in the process (for example: what’s challenging or what’s confusing) and then integrate your feedback into our upcoming iterations. We appreciate your patience as we continue to fill in the gaps and iron out issues along the way. Your open and honest feedback will help us improve GC Forms and shape the future of this product.
From 99225bdb8cd49198805db082781eedef2d44dd8b Mon Sep 17 00:00:00 2001
From: Anik Brazeau <38330843+anikbrazeau@users.noreply.github.com>
Date: Wed, 23 Oct 2024 17:13:36 -0400
Subject: [PATCH 123/440] Update navigation.html
---
docs/_includes/navigation.html | 1 -
1 file changed, 1 deletion(-)
diff --git a/docs/_includes/navigation.html b/docs/_includes/navigation.html
index 883f61a7..6d32fb96 100644
--- a/docs/_includes/navigation.html
+++ b/docs/_includes/navigation.html
@@ -1,4 +1,3 @@
-Table of contents
{% assign mydocs = site.pages | where:"lang","en" | where:"layout","page" | group_by: 'category' | sort: 'name' %}
{% for cat in mydocs %}
{{ cat.name | capitalize }}
From 4d0fcd9780200e8766d8c4a0d68426a180e6a34c Mon Sep 17 00:00:00 2001
From: Anik Brazeau <38330843+anikbrazeau@users.noreply.github.com>
Date: Wed, 23 Oct 2024 17:14:22 -0400
Subject: [PATCH 124/440] Update navigation-fr.html
---
docs/_includes/navigation-fr.html | 1 -
1 file changed, 1 deletion(-)
diff --git a/docs/_includes/navigation-fr.html b/docs/_includes/navigation-fr.html
index 1beb8e27..3e54f7fc 100644
--- a/docs/_includes/navigation-fr.html
+++ b/docs/_includes/navigation-fr.html
@@ -1,4 +1,3 @@
-Table des matières
{% assign mydocs = site.pages | where:"lang","fr" | where:"layout","page" | group_by: 'category' | sort: 'name' %}
{% for cat in mydocs %}
{{ cat.name | capitalize }}
From d79bdd6cb03f6adce6d91ffae2802cf192d3c14a Mon Sep 17 00:00:00 2001
From: Anik Brazeau <38330843+anikbrazeau@users.noreply.github.com>
Date: Wed, 23 Oct 2024 17:19:29 -0400
Subject: [PATCH 125/440] Update homepage.html
---
docs/_layouts/homepage.html | 4 ++++
1 file changed, 4 insertions(+)
diff --git a/docs/_layouts/homepage.html b/docs/_layouts/homepage.html
index 73dae177..fb296db3 100644
--- a/docs/_layouts/homepage.html
+++ b/docs/_layouts/homepage.html
@@ -1,4 +1,8 @@
---
layout: default
---
+{{ page.title }}
+
{{ content }}
+
+{% include repositories.html %}
From 579a80f66cb16853f5b7c78d11235bf16a1a9115 Mon Sep 17 00:00:00 2001
From: Anik Brazeau <38330843+anikbrazeau@users.noreply.github.com>
Date: Thu, 24 Oct 2024 08:12:45 -0400
Subject: [PATCH 126/440] Create accueil.html
---
docs/accueil.html | 8 ++++++++
1 file changed, 8 insertions(+)
create mode 100644 docs/accueil.html
diff --git a/docs/accueil.html b/docs/accueil.html
new file mode 100644
index 00000000..2f72d53a
--- /dev/null
+++ b/docs/accueil.html
@@ -0,0 +1,8 @@
+---
+layout: default
+lang: fr
+trans_url: /home
+---
+{% include navigation.html %}
+{% capture index %}{% include accueil.md %}{% endcapture %}
+{{ index | markdownify }}
From 7a1cd1a7c29bc79a705ed2a2b8ed97000932a690 Mon Sep 17 00:00:00 2001
From: Anik Brazeau <38330843+anikbrazeau@users.noreply.github.com>
Date: Thu, 24 Oct 2024 08:13:00 -0400
Subject: [PATCH 127/440] Rename contexte.md to accueil.md
---
docs/_pages/fr/{contexte.md => accueil.md} | 0
1 file changed, 0 insertions(+), 0 deletions(-)
rename docs/_pages/fr/{contexte.md => accueil.md} (100%)
diff --git a/docs/_pages/fr/contexte.md b/docs/_pages/fr/accueil.md
similarity index 100%
rename from docs/_pages/fr/contexte.md
rename to docs/_pages/fr/accueil.md
From 7b235e059eb12560845764abed3e742a45605235 Mon Sep 17 00:00:00 2001
From: Anik Brazeau <38330843+anikbrazeau@users.noreply.github.com>
Date: Thu, 24 Oct 2024 08:24:07 -0400
Subject: [PATCH 128/440] Update accueil.md
---
docs/_pages/fr/accueil.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/_pages/fr/accueil.md b/docs/_pages/fr/accueil.md
index 8b137891..a2f176a9 100644
--- a/docs/_pages/fr/accueil.md
+++ b/docs/_pages/fr/accueil.md
@@ -1 +1 @@
-
+Accueil
From 199cd9241903955b2f68c11cd4304d2ecc745e8d Mon Sep 17 00:00:00 2001
From: Anik Brazeau <38330843+anikbrazeau@users.noreply.github.com>
Date: Thu, 24 Oct 2024 08:25:48 -0400
Subject: [PATCH 129/440] Update default.html
---
docs/_layouts/default.html | 28 +++++++++++++++++++++++++++-
1 file changed, 27 insertions(+), 1 deletion(-)
diff --git a/docs/_layouts/default.html b/docs/_layouts/default.html
index e798c19c..8ce0a582 100644
--- a/docs/_layouts/default.html
+++ b/docs/_layouts/default.html
@@ -1,8 +1,9 @@
-
+
+