govuk_tech_docs 6.3.0.beta → 6.4.0.beta
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.github/ISSUE_TEMPLATE/documentation.yaml +29 -0
- data/.github/workflows/build-middleman-artifact.yaml +41 -0
- data/.github/workflows/check-documentation-updates.yaml +32 -0
- data/.github/workflows/check-gem-version.yaml +36 -0
- data/.github/workflows/dependency-review.yaml +2 -5
- data/.github/workflows/pipeline.yaml +50 -0
- data/.github/workflows/publish-gem.yaml +61 -0
- data/.github/workflows/publish-github-pages.yaml +38 -0
- data/.github/workflows/test.yaml +17 -10
- data/.gitignore +5 -4
- data/.rspec +1 -0
- data/CHANGELOG.md +17 -4
- data/README.md +10 -10
- data/Rakefile +1 -1
- data/documentation/.nvmrc +1 -0
- data/documentation/Gemfile +11 -0
- data/documentation/LICENSE +21 -0
- data/documentation/README.md +30 -0
- data/documentation/Staticfile +4 -0
- data/documentation/config/tech-docs.yml +45 -0
- data/{example → documentation}/config.rb +3 -6
- data/documentation/source/accessibility/index.html.md.erb +64 -0
- data/documentation/source/configure_project/frontmatter/index.html.md.erb +206 -0
- data/documentation/source/configure_project/global_configuration/index.html.md.erb +328 -0
- data/documentation/source/configure_project/index.html.md.erb +17 -0
- data/documentation/source/configure_project/page_expiry_and_review/index.html.md.erb +93 -0
- data/documentation/source/configure_project/structure_docs/index.html.md.erb +117 -0
- data/documentation/source/create_project/build/index.html.md.erb +20 -0
- data/documentation/source/create_project/create_new_project/index.html.md.erb +23 -0
- data/documentation/source/create_project/get_started/index.html.md.erb +58 -0
- data/documentation/source/create_project/index.html.md.erb +17 -0
- data/documentation/source/create_project/preview/index.html.md.erb +26 -0
- data/documentation/source/images/Basic multipage.svg +1 -0
- data/documentation/source/images/Basic_multipage.svg +1 -0
- data/documentation/source/images/Nested multipage.svg +1 -0
- data/documentation/source/images/Nested_multipage.svg +1 -0
- data/documentation/source/images/Single_page.svg +1 -0
- data/documentation/source/images/core-layout-without-sidebar.png +0 -0
- data/documentation/source/images/core-layout.png +0 -0
- data/documentation/source/images/daniel-the-manual-spaniel-screenshot.svg +1 -0
- data/documentation/source/images/expired-page.png +0 -0
- data/documentation/source/images/last-reviewed-only.png +0 -0
- data/documentation/source/images/last-reviewed-only.svg +1 -0
- data/documentation/source/images/layout-layout.png +0 -0
- data/documentation/source/images/multipage.svg +3 -0
- data/documentation/source/images/not-expired-page.png +0 -0
- data/documentation/source/index.html.md.erb +19 -0
- data/documentation/source/maintain_project/index.html.md.erb +18 -0
- data/documentation/source/maintain_project/redirects/index.html.md.erb +22 -0
- data/documentation/source/maintain_project/review_content/index.html.md.erb +45 -0
- data/documentation/source/maintain_project/use_latest_template/index.html.md.erb +34 -0
- data/documentation/source/partials/_links.erb +81 -0
- data/documentation/source/publish_project/deploy/index.html.md.erb +44 -0
- data/documentation/source/publish_project/index.html.md.erb +15 -0
- data/documentation/source/publish_project/version/index.html.md.erb +12 -0
- data/documentation/source/support/index.html.md.erb +46 -0
- data/documentation/source/write_docs/add_openapi_spec/index.html.md.erb +48 -0
- data/documentation/source/write_docs/content/index.html.md.erb +128 -0
- data/documentation/source/write_docs/index.html.md.erb +15 -0
- data/lib/govuk_tech_docs/version.rb +1 -1
- data/lib/source/layouts/_footer.erb +2 -2
- data/lib/source/layouts/_header.erb +2 -2
- data/lib/source/layouts/_service_navigation.erb +2 -5
- data/lib/source/layouts/core.erb +12 -6
- data/node_modules/govuk-frontend/dist/govuk/_base.import.scss +6 -0
- data/node_modules/govuk-frontend/dist/govuk/_base.scss +4 -5
- data/node_modules/govuk-frontend/dist/govuk/all.bundle.js +32 -26
- data/node_modules/govuk-frontend/dist/govuk/all.bundle.mjs +32 -26
- data/node_modules/govuk-frontend/dist/govuk/assets/images/govuk-icon-180.png +0 -0
- data/node_modules/govuk-frontend/dist/govuk/assets/images/govuk-icon-192.png +0 -0
- data/node_modules/govuk-frontend/dist/govuk/assets/images/govuk-icon-512.png +0 -0
- data/node_modules/govuk-frontend/dist/govuk/common/govuk-frontend-version.mjs +1 -1
- data/node_modules/govuk-frontend/dist/govuk/components/_index.import.scss +38 -0
- data/node_modules/govuk-frontend/dist/govuk/components/_index.scss +37 -39
- data/node_modules/govuk-frontend/dist/govuk/components/accordion/_accordion.import.scss +6 -0
- data/node_modules/govuk-frontend/dist/govuk/components/accordion/_index.import.scss +8 -0
- data/node_modules/govuk-frontend/dist/govuk/components/accordion/_index.scss +3 -373
- data/node_modules/govuk-frontend/dist/govuk/components/accordion/_mixin.scss +375 -0
- data/node_modules/govuk-frontend/dist/govuk/components/back-link/_back-link.import.scss +6 -0
- data/node_modules/govuk-frontend/dist/govuk/components/back-link/_index.import.scss +8 -0
- data/node_modules/govuk-frontend/dist/govuk/components/back-link/_index.scss +3 -85
- data/node_modules/govuk-frontend/dist/govuk/components/back-link/_mixin.scss +87 -0
- data/node_modules/govuk-frontend/dist/govuk/components/breadcrumbs/_breadcrumbs.import.scss +6 -0
- data/node_modules/govuk-frontend/dist/govuk/components/breadcrumbs/_index.import.scss +8 -0
- data/node_modules/govuk-frontend/dist/govuk/components/breadcrumbs/_index.scss +3 -136
- data/node_modules/govuk-frontend/dist/govuk/components/breadcrumbs/_mixin.scss +134 -0
- data/node_modules/govuk-frontend/dist/govuk/components/button/_button.import.scss +6 -0
- data/node_modules/govuk-frontend/dist/govuk/components/button/_index.import.scss +13 -0
- data/node_modules/govuk-frontend/dist/govuk/components/button/_index.scss +9 -259
- data/node_modules/govuk-frontend/dist/govuk/components/button/_mixin.scss +233 -0
- data/node_modules/govuk-frontend/dist/govuk/components/button/_settings.import.scss +32 -0
- data/node_modules/govuk-frontend/dist/govuk/components/button/_settings.scss +34 -0
- data/node_modules/govuk-frontend/dist/govuk/components/character-count/_character-count.import.scss +6 -0
- data/node_modules/govuk-frontend/dist/govuk/components/character-count/_index.import.scss +12 -0
- data/node_modules/govuk-frontend/dist/govuk/components/character-count/_index.scss +7 -44
- data/node_modules/govuk-frontend/dist/govuk/components/character-count/_mixin.scss +41 -0
- data/node_modules/govuk-frontend/dist/govuk/components/checkboxes/_checkboxes.import.scss +6 -0
- data/node_modules/govuk-frontend/dist/govuk/components/checkboxes/_index.import.scss +12 -0
- data/node_modules/govuk-frontend/dist/govuk/components/checkboxes/_index.scss +7 -314
- data/node_modules/govuk-frontend/dist/govuk/components/checkboxes/_mixin.scss +317 -0
- data/node_modules/govuk-frontend/dist/govuk/components/cookie-banner/_cookie-banner.import.scss +6 -0
- data/node_modules/govuk-frontend/dist/govuk/components/cookie-banner/_index.import.scss +9 -0
- data/node_modules/govuk-frontend/dist/govuk/components/cookie-banner/_index.scss +4 -55
- data/node_modules/govuk-frontend/dist/govuk/components/cookie-banner/_mixin.scss +56 -0
- data/node_modules/govuk-frontend/dist/govuk/components/date-input/_date-input.import.scss +6 -0
- data/node_modules/govuk-frontend/dist/govuk/components/date-input/_index.import.scss +13 -0
- data/node_modules/govuk-frontend/dist/govuk/components/date-input/_index.scss +8 -33
- data/node_modules/govuk-frontend/dist/govuk/components/date-input/_mixin.scss +29 -0
- data/node_modules/govuk-frontend/dist/govuk/components/details/_details.import.scss +6 -0
- data/node_modules/govuk-frontend/dist/govuk/components/details/_index.import.scss +8 -0
- data/node_modules/govuk-frontend/dist/govuk/components/details/_index.scss +3 -141
- data/node_modules/govuk-frontend/dist/govuk/components/details/_mixin.scss +143 -0
- data/node_modules/govuk-frontend/dist/govuk/components/error-message/_error-message.import.scss +6 -0
- data/node_modules/govuk-frontend/dist/govuk/components/error-message/_index.import.scss +8 -0
- data/node_modules/govuk-frontend/dist/govuk/components/error-message/_index.scss +3 -14
- data/node_modules/govuk-frontend/dist/govuk/components/error-message/_mixin.scss +16 -0
- data/node_modules/govuk-frontend/dist/govuk/components/error-summary/_error-summary.import.scss +6 -0
- data/node_modules/govuk-frontend/dist/govuk/components/error-summary/_index.import.scss +8 -0
- data/node_modules/govuk-frontend/dist/govuk/components/error-summary/_index.scss +3 -57
- data/node_modules/govuk-frontend/dist/govuk/components/error-summary/_mixin.scss +58 -0
- data/node_modules/govuk-frontend/dist/govuk/components/exit-this-page/_exit-this-page.import.scss +6 -0
- data/node_modules/govuk-frontend/dist/govuk/components/exit-this-page/_index.import.scss +9 -0
- data/node_modules/govuk-frontend/dist/govuk/components/exit-this-page/_index.scss +4 -91
- data/node_modules/govuk-frontend/dist/govuk/components/exit-this-page/_mixin.scss +96 -0
- data/node_modules/govuk-frontend/dist/govuk/components/fieldset/_fieldset.import.scss +6 -0
- data/node_modules/govuk-frontend/dist/govuk/components/fieldset/_index.import.scss +8 -0
- data/node_modules/govuk-frontend/dist/govuk/components/fieldset/_index.scss +3 -69
- data/node_modules/govuk-frontend/dist/govuk/components/fieldset/_mixin.scss +71 -0
- data/node_modules/govuk-frontend/dist/govuk/components/file-upload/_file-upload.import.scss +6 -0
- data/node_modules/govuk-frontend/dist/govuk/components/file-upload/_index.import.scss +11 -0
- data/node_modules/govuk-frontend/dist/govuk/components/file-upload/_index.scss +6 -211
- data/node_modules/govuk-frontend/dist/govuk/components/file-upload/_mixin.scss +217 -0
- data/node_modules/govuk-frontend/dist/govuk/components/file-upload/file-upload.bundle.js +31 -25
- data/node_modules/govuk-frontend/dist/govuk/components/file-upload/file-upload.bundle.mjs +31 -25
- data/node_modules/govuk-frontend/dist/govuk/components/file-upload/file-upload.mjs +31 -26
- data/node_modules/govuk-frontend/dist/govuk/components/footer/_footer.import.scss +6 -0
- data/node_modules/govuk-frontend/dist/govuk/components/footer/_index.import.scss +8 -0
- data/node_modules/govuk-frontend/dist/govuk/components/footer/_index.scss +3 -197
- data/node_modules/govuk-frontend/dist/govuk/components/footer/_mixin.scss +199 -0
- data/node_modules/govuk-frontend/dist/govuk/components/generic-header/_generic-header.import.scss +6 -0
- data/node_modules/govuk-frontend/dist/govuk/components/generic-header/_index.import.scss +8 -0
- data/node_modules/govuk-frontend/dist/govuk/components/generic-header/_index.scss +5 -0
- data/node_modules/govuk-frontend/dist/govuk/components/generic-header/_mixin.scss +140 -0
- data/node_modules/govuk-frontend/dist/govuk/components/header/_header.import.scss +6 -0
- data/node_modules/govuk-frontend/dist/govuk/components/header/_index.import.scss +8 -0
- data/node_modules/govuk-frontend/dist/govuk/components/header/_index.scss +3 -188
- data/node_modules/govuk-frontend/dist/govuk/components/header/_mixin.scss +119 -0
- data/node_modules/govuk-frontend/dist/govuk/components/hint/_hint.import.scss +6 -0
- data/node_modules/govuk-frontend/dist/govuk/components/hint/_index.import.scss +8 -0
- data/node_modules/govuk-frontend/dist/govuk/components/hint/_index.scss +3 -45
- data/node_modules/govuk-frontend/dist/govuk/components/hint/_mixin.scss +47 -0
- data/node_modules/govuk-frontend/dist/govuk/components/input/_index.import.scss +11 -0
- data/node_modules/govuk-frontend/dist/govuk/components/input/_index.scss +6 -162
- data/node_modules/govuk-frontend/dist/govuk/components/input/_input.import.scss +6 -0
- data/node_modules/govuk-frontend/dist/govuk/components/input/_mixin.scss +161 -0
- data/node_modules/govuk-frontend/dist/govuk/components/inset-text/_index.import.scss +8 -0
- data/node_modules/govuk-frontend/dist/govuk/components/inset-text/_index.scss +3 -29
- data/node_modules/govuk-frontend/dist/govuk/components/inset-text/_inset-text.import.scss +6 -0
- data/node_modules/govuk-frontend/dist/govuk/components/inset-text/_mixin.scss +31 -0
- data/node_modules/govuk-frontend/dist/govuk/components/label/_index.import.scss +8 -0
- data/node_modules/govuk-frontend/dist/govuk/components/label/_index.scss +3 -46
- data/node_modules/govuk-frontend/dist/govuk/components/label/_label.import.scss +6 -0
- data/node_modules/govuk-frontend/dist/govuk/components/label/_mixin.scss +48 -0
- data/node_modules/govuk-frontend/dist/govuk/components/notification-banner/_index.import.scss +8 -0
- data/node_modules/govuk-frontend/dist/govuk/components/notification-banner/_index.scss +3 -97
- data/node_modules/govuk-frontend/dist/govuk/components/notification-banner/_mixin.scss +100 -0
- data/node_modules/govuk-frontend/dist/govuk/components/notification-banner/_notification-banner.import.scss +6 -0
- data/node_modules/govuk-frontend/dist/govuk/components/pagination/_index.import.scss +8 -0
- data/node_modules/govuk-frontend/dist/govuk/components/pagination/_index.scss +3 -233
- data/node_modules/govuk-frontend/dist/govuk/components/pagination/_mixin.scss +235 -0
- data/node_modules/govuk-frontend/dist/govuk/components/pagination/_pagination.import.scss +6 -0
- data/node_modules/govuk-frontend/dist/govuk/components/panel/_index.import.scss +8 -0
- data/node_modules/govuk-frontend/dist/govuk/components/panel/_index.scss +3 -58
- data/node_modules/govuk-frontend/dist/govuk/components/panel/_mixin.scss +94 -0
- data/node_modules/govuk-frontend/dist/govuk/components/panel/_panel.import.scss +6 -0
- data/node_modules/govuk-frontend/dist/govuk/components/password-input/_index.import.scss +10 -0
- data/node_modules/govuk-frontend/dist/govuk/components/password-input/_index.scss +5 -56
- data/node_modules/govuk-frontend/dist/govuk/components/password-input/_mixin.scss +56 -0
- data/node_modules/govuk-frontend/dist/govuk/components/password-input/_password-input.import.scss +6 -0
- data/node_modules/govuk-frontend/dist/govuk/components/phase-banner/_index.import.scss +9 -0
- data/node_modules/govuk-frontend/dist/govuk/components/phase-banner/_index.scss +4 -41
- data/node_modules/govuk-frontend/dist/govuk/components/phase-banner/_mixin.scss +42 -0
- data/node_modules/govuk-frontend/dist/govuk/components/phase-banner/_phase-banner.import.scss +6 -0
- data/node_modules/govuk-frontend/dist/govuk/components/radios/_index.import.scss +12 -0
- data/node_modules/govuk-frontend/dist/govuk/components/radios/_index.scss +7 -330
- data/node_modules/govuk-frontend/dist/govuk/components/radios/_mixin.scss +336 -0
- data/node_modules/govuk-frontend/dist/govuk/components/radios/_radios.import.scss +6 -0
- data/node_modules/govuk-frontend/dist/govuk/components/select/_index.import.scss +11 -0
- data/node_modules/govuk-frontend/dist/govuk/components/select/_index.scss +6 -53
- data/node_modules/govuk-frontend/dist/govuk/components/select/_mixin.scss +45 -0
- data/node_modules/govuk-frontend/dist/govuk/components/select/_select.import.scss +6 -0
- data/node_modules/govuk-frontend/dist/govuk/components/service-navigation/_index.import.scss +8 -0
- data/node_modules/govuk-frontend/dist/govuk/components/service-navigation/_index.scss +3 -235
- data/node_modules/govuk-frontend/dist/govuk/components/service-navigation/_mixin.scss +238 -0
- data/node_modules/govuk-frontend/dist/govuk/components/service-navigation/_service-navigation.import.scss +6 -0
- data/node_modules/govuk-frontend/dist/govuk/components/skip-link/_index.import.scss +8 -0
- data/node_modules/govuk-frontend/dist/govuk/components/skip-link/_index.scss +3 -58
- data/node_modules/govuk-frontend/dist/govuk/components/skip-link/_mixin.scss +60 -0
- data/node_modules/govuk-frontend/dist/govuk/components/skip-link/_skip-link.import.scss +6 -0
- data/node_modules/govuk-frontend/dist/govuk/components/summary-list/_index.import.scss +8 -0
- data/node_modules/govuk-frontend/dist/govuk/components/summary-list/_index.scss +3 -284
- data/node_modules/govuk-frontend/dist/govuk/components/summary-list/_mixin.scss +286 -0
- data/node_modules/govuk-frontend/dist/govuk/components/summary-list/_summary-list.import.scss +6 -0
- data/node_modules/govuk-frontend/dist/govuk/components/table/_index.import.scss +8 -0
- data/node_modules/govuk-frontend/dist/govuk/components/table/_index.scss +3 -75
- data/node_modules/govuk-frontend/dist/govuk/components/table/_mixin.scss +77 -0
- data/node_modules/govuk-frontend/dist/govuk/components/table/_table.import.scss +6 -0
- data/node_modules/govuk-frontend/dist/govuk/components/tabs/_index.import.scss +8 -0
- data/node_modules/govuk-frontend/dist/govuk/components/tabs/_index.scss +3 -138
- data/node_modules/govuk-frontend/dist/govuk/components/tabs/_mixin.scss +140 -0
- data/node_modules/govuk-frontend/dist/govuk/components/tabs/_tabs.import.scss +6 -0
- data/node_modules/govuk-frontend/dist/govuk/components/tag/_index.import.scss +8 -0
- data/node_modules/govuk-frontend/dist/govuk/components/tag/_index.scss +3 -132
- data/node_modules/govuk-frontend/dist/govuk/components/tag/_mixin.scss +135 -0
- data/node_modules/govuk-frontend/dist/govuk/components/tag/_tag.import.scss +6 -0
- data/node_modules/govuk-frontend/dist/govuk/components/task-list/_index.import.scss +9 -0
- data/node_modules/govuk-frontend/dist/govuk/components/task-list/_index.scss +4 -82
- data/node_modules/govuk-frontend/dist/govuk/components/task-list/_mixin.scss +83 -0
- data/node_modules/govuk-frontend/dist/govuk/components/task-list/_task-list.import.scss +6 -0
- data/node_modules/govuk-frontend/dist/govuk/components/textarea/_index.import.scss +11 -0
- data/node_modules/govuk-frontend/dist/govuk/components/textarea/_index.scss +6 -44
- data/node_modules/govuk-frontend/dist/govuk/components/textarea/_mixin.scss +43 -0
- data/node_modules/govuk-frontend/dist/govuk/components/textarea/_textarea.import.scss +6 -0
- data/node_modules/govuk-frontend/dist/govuk/components/warning-text/_index.import.scss +8 -0
- data/node_modules/govuk-frontend/dist/govuk/components/warning-text/_index.scss +3 -67
- data/node_modules/govuk-frontend/dist/govuk/components/warning-text/_mixin.scss +69 -0
- data/node_modules/govuk-frontend/dist/govuk/components/warning-text/_warning-text.import.scss +6 -0
- data/node_modules/govuk-frontend/dist/govuk/core/_global-styles.import.scss +10 -0
- data/node_modules/govuk-frontend/dist/govuk/core/_global-styles.mixin.scss +19 -0
- data/node_modules/govuk-frontend/dist/govuk/core/_global-styles.scss +5 -22
- data/node_modules/govuk-frontend/dist/govuk/core/_index.import.scss +6 -0
- data/node_modules/govuk-frontend/dist/govuk/core/_index.scss +6 -10
- data/node_modules/govuk-frontend/dist/govuk/core/_links.import.scss +10 -0
- data/node_modules/govuk-frontend/dist/govuk/core/_links.mixin.scss +44 -0
- data/node_modules/govuk-frontend/dist/govuk/core/_links.scss +3 -48
- data/node_modules/govuk-frontend/dist/govuk/core/_lists.import.scss +14 -0
- data/node_modules/govuk-frontend/dist/govuk/core/_lists.mixin.scss +74 -0
- data/node_modules/govuk-frontend/dist/govuk/core/_lists.scss +6 -73
- data/node_modules/govuk-frontend/dist/govuk/core/_section-break.import.scss +8 -0
- data/node_modules/govuk-frontend/dist/govuk/core/_section-break.mixin.scss +54 -0
- data/node_modules/govuk-frontend/dist/govuk/core/_section-break.scss +3 -55
- data/node_modules/govuk-frontend/dist/govuk/core/_typography.import.scss +8 -0
- data/node_modules/govuk-frontend/dist/govuk/core/_typography.mixin.scss +173 -0
- data/node_modules/govuk-frontend/dist/govuk/core/_typography.scss +3 -174
- data/node_modules/govuk-frontend/dist/govuk/custom-properties/_breakpoints.import.scss +8 -0
- data/node_modules/govuk-frontend/dist/govuk/custom-properties/_breakpoints.mixin.scss +15 -0
- data/node_modules/govuk-frontend/dist/govuk/custom-properties/_breakpoints.scss +2 -15
- data/node_modules/govuk-frontend/dist/govuk/custom-properties/_frontend-version.import.scss +8 -0
- data/node_modules/govuk-frontend/dist/govuk/custom-properties/_frontend-version.mixin.scss +13 -0
- data/node_modules/govuk-frontend/dist/govuk/custom-properties/_frontend-version.scss +2 -13
- data/node_modules/govuk-frontend/dist/govuk/custom-properties/_functional-colours.import.scss +8 -0
- data/node_modules/govuk-frontend/dist/govuk/custom-properties/_functional-colours.mixin.scss +21 -0
- data/node_modules/govuk-frontend/dist/govuk/custom-properties/_functional-colours.scss +2 -20
- data/node_modules/govuk-frontend/dist/govuk/custom-properties/_index.import.scss +4 -0
- data/node_modules/govuk-frontend/dist/govuk/custom-properties/_index.scss +3 -4
- data/node_modules/govuk-frontend/dist/govuk/govuk-frontend.min.js +1 -1
- data/node_modules/govuk-frontend/dist/govuk/helpers/_clearfix.import.scss +2 -0
- data/node_modules/govuk-frontend/dist/govuk/helpers/_clearfix.scss +0 -1
- data/node_modules/govuk-frontend/dist/govuk/helpers/_colour.import.scss +2 -0
- data/node_modules/govuk-frontend/dist/govuk/helpers/_colour.scss +35 -17
- data/node_modules/govuk-frontend/dist/govuk/helpers/_device-pixels.import.scss +2 -0
- data/node_modules/govuk-frontend/dist/govuk/helpers/_device-pixels.scss +2 -3
- data/node_modules/govuk-frontend/dist/govuk/helpers/_focused.import.scss +2 -0
- data/node_modules/govuk-frontend/dist/govuk/helpers/_focused.scss +3 -1
- data/node_modules/govuk-frontend/dist/govuk/helpers/{_font-faces.scss → _font-faces--internal.scss} +5 -5
- data/node_modules/govuk-frontend/dist/govuk/helpers/_grid.import.scss +2 -0
- data/node_modules/govuk-frontend/dist/govuk/helpers/_grid.scss +3 -1
- data/node_modules/govuk-frontend/dist/govuk/helpers/_index.import.scss +2 -0
- data/node_modules/govuk-frontend/dist/govuk/helpers/_index.scss +12 -13
- data/node_modules/govuk-frontend/dist/govuk/helpers/_links.import.scss +2 -0
- data/node_modules/govuk-frontend/dist/govuk/helpers/_links.scss +7 -2
- data/node_modules/govuk-frontend/dist/govuk/helpers/_media-queries.import.scss +2 -0
- data/node_modules/govuk-frontend/dist/govuk/helpers/_media-queries.scss +2 -3
- data/node_modules/govuk-frontend/dist/govuk/helpers/_shape-arrow.import.scss +2 -0
- data/node_modules/govuk-frontend/dist/govuk/helpers/_shape-arrow.scss +0 -1
- data/node_modules/govuk-frontend/dist/govuk/helpers/_spacing--internal.scss +80 -0
- data/node_modules/govuk-frontend/dist/govuk/helpers/_spacing.import.scss +2 -0
- data/node_modules/govuk-frontend/dist/govuk/helpers/_spacing.scss +18 -79
- data/node_modules/govuk-frontend/dist/govuk/helpers/_typography--internal.scss +24 -0
- data/node_modules/govuk-frontend/dist/govuk/helpers/_typography.import.scss +2 -0
- data/node_modules/govuk-frontend/dist/govuk/helpers/_typography.scss +20 -37
- data/node_modules/govuk-frontend/dist/govuk/helpers/_visually-hidden.import.scss +2 -0
- data/node_modules/govuk-frontend/dist/govuk/helpers/_visually-hidden.scss +1 -2
- data/node_modules/govuk-frontend/dist/govuk/helpers/_width-container.import.scss +2 -0
- data/node_modules/govuk-frontend/dist/govuk/helpers/_width-container.scss +73 -0
- data/node_modules/govuk-frontend/dist/govuk/index.import.scss +10 -0
- data/node_modules/govuk-frontend/dist/govuk/index.scss +6 -7
- data/node_modules/govuk-frontend/dist/govuk/objects/_button-group.import.scss +8 -0
- data/node_modules/govuk-frontend/dist/govuk/objects/_button-group.mixin.scss +80 -0
- data/node_modules/govuk-frontend/dist/govuk/objects/_button-group.scss +3 -78
- data/node_modules/govuk-frontend/dist/govuk/objects/_form-group.import.scss +8 -0
- data/node_modules/govuk-frontend/dist/govuk/objects/_form-group.mixin.scss +26 -0
- data/node_modules/govuk-frontend/dist/govuk/objects/_form-group.scss +3 -24
- data/node_modules/govuk-frontend/dist/govuk/objects/_grid.import.scss +8 -0
- data/node_modules/govuk-frontend/dist/govuk/objects/_grid.mixin.scss +28 -0
- data/node_modules/govuk-frontend/dist/govuk/objects/_grid.scss +3 -26
- data/node_modules/govuk-frontend/dist/govuk/objects/_index.import.scss +7 -0
- data/node_modules/govuk-frontend/dist/govuk/objects/_index.scss +6 -7
- data/node_modules/govuk-frontend/dist/govuk/objects/_main-wrapper.import.scss +8 -0
- data/node_modules/govuk-frontend/dist/govuk/objects/_main-wrapper.mixin.scss +55 -0
- data/node_modules/govuk-frontend/dist/govuk/objects/_main-wrapper.scss +3 -53
- data/node_modules/govuk-frontend/dist/govuk/objects/_template.import.scss +8 -0
- data/node_modules/govuk-frontend/dist/govuk/objects/_template.mixin.scss +53 -0
- data/node_modules/govuk-frontend/dist/govuk/objects/_template.scss +3 -51
- data/node_modules/govuk-frontend/dist/govuk/objects/_width-container.import.scss +8 -0
- data/node_modules/govuk-frontend/dist/govuk/objects/_width-container.mixin.scss +9 -0
- data/node_modules/govuk-frontend/dist/govuk/objects/_width-container.scss +3 -76
- data/node_modules/govuk-frontend/dist/govuk/overrides/_display.import.scss +8 -0
- data/node_modules/govuk-frontend/dist/govuk/overrides/_display.mixin.scss +26 -0
- data/node_modules/govuk-frontend/dist/govuk/overrides/_display.scss +2 -26
- data/node_modules/govuk-frontend/dist/govuk/overrides/_index.import.scss +6 -0
- data/node_modules/govuk-frontend/dist/govuk/overrides/_index.scss +5 -9
- data/node_modules/govuk-frontend/dist/govuk/overrides/_spacing.import.scss +8 -0
- data/node_modules/govuk-frontend/dist/govuk/overrides/_spacing.mixin.scss +89 -0
- data/node_modules/govuk-frontend/dist/govuk/overrides/_spacing.scss +2 -88
- data/node_modules/govuk-frontend/dist/govuk/overrides/_text-align.import.scss +8 -0
- data/node_modules/govuk-frontend/dist/govuk/overrides/_text-align.mixin.scss +16 -0
- data/node_modules/govuk-frontend/dist/govuk/overrides/_text-align.scss +2 -16
- data/node_modules/govuk-frontend/dist/govuk/overrides/_typography.import.scss +8 -0
- data/node_modules/govuk-frontend/dist/govuk/overrides/_typography.mixin.scss +43 -0
- data/node_modules/govuk-frontend/dist/govuk/overrides/_typography.scss +2 -43
- data/node_modules/govuk-frontend/dist/govuk/overrides/_width.import.scss +8 -0
- data/node_modules/govuk-frontend/dist/govuk/overrides/_width.mixin.scss +50 -0
- data/node_modules/govuk-frontend/dist/govuk/overrides/_width.scss +2 -49
- data/node_modules/govuk-frontend/dist/govuk/settings/_assets.import.scss +13 -0
- data/node_modules/govuk-frontend/dist/govuk/settings/_assets.scss +46 -35
- data/node_modules/govuk-frontend/dist/govuk/settings/_colours-applied.import.scss +13 -0
- data/node_modules/govuk-frontend/dist/govuk/settings/_colours-functional.import.scss +2 -0
- data/node_modules/govuk-frontend/dist/govuk/settings/_colours-functional.scss +13 -235
- data/node_modules/govuk-frontend/dist/govuk/settings/_colours-legacy-functional.import.scss +2 -0
- data/node_modules/govuk-frontend/dist/govuk/settings/_colours-legacy-functional.scss +188 -0
- data/node_modules/govuk-frontend/dist/govuk/settings/_colours-organisations.import.scss +2 -0
- data/node_modules/govuk-frontend/dist/govuk/settings/_colours-organisations.scss +1 -20
- data/node_modules/govuk-frontend/dist/govuk/settings/{_colours-palette.scss → _colours-palette--internal.scss} +2 -3
- data/node_modules/govuk-frontend/dist/govuk/settings/_custom-properties.import.scss +2 -0
- data/node_modules/govuk-frontend/dist/govuk/settings/_custom-properties.scss +0 -1
- data/node_modules/govuk-frontend/dist/govuk/settings/_global-styles.import.scss +2 -0
- data/node_modules/govuk-frontend/dist/govuk/settings/_global-styles.scss +0 -1
- data/node_modules/govuk-frontend/dist/govuk/settings/_index.import.scss +24 -0
- data/node_modules/govuk-frontend/dist/govuk/settings/_index.scss +13 -14
- data/node_modules/govuk-frontend/dist/govuk/settings/_links.import.scss +2 -0
- data/node_modules/govuk-frontend/dist/govuk/settings/_links.scss +0 -1
- data/node_modules/govuk-frontend/dist/govuk/settings/_measurements.import.scss +2 -0
- data/node_modules/govuk-frontend/dist/govuk/settings/_measurements.scss +2 -3
- data/node_modules/govuk-frontend/dist/govuk/settings/_media-queries.import.scss +2 -0
- data/node_modules/govuk-frontend/dist/govuk/settings/_media-queries.scss +0 -1
- data/node_modules/govuk-frontend/dist/govuk/settings/_spacing.import.scss +2 -0
- data/node_modules/govuk-frontend/dist/govuk/settings/_spacing.scss +0 -1
- data/node_modules/govuk-frontend/dist/govuk/settings/_typography-font.import.scss +2 -0
- data/node_modules/govuk-frontend/dist/govuk/settings/_typography-font.scss +2 -4
- data/node_modules/govuk-frontend/dist/govuk/settings/_typography-responsive.import.scss +2 -0
- data/node_modules/govuk-frontend/dist/govuk/settings/_typography-responsive.scss +0 -1
- data/node_modules/govuk-frontend/dist/govuk/settings/_warnings--internal.scss +69 -0
- data/node_modules/govuk-frontend/dist/govuk/settings/_warnings.import.scss +2 -0
- data/node_modules/govuk-frontend/dist/govuk/settings/_warnings.scss +9 -69
- data/node_modules/govuk-frontend/dist/govuk/tools/_exports.import.scss +2 -0
- data/node_modules/govuk-frontend/dist/govuk/tools/_exports.scss +11 -6
- data/node_modules/govuk-frontend/dist/govuk/tools/_font-url.import.scss +31 -0
- data/node_modules/govuk-frontend/dist/govuk/tools/_font-url.scss +9 -1
- data/node_modules/govuk-frontend/dist/govuk/tools/_if.import.scss +2 -0
- data/node_modules/govuk-frontend/dist/govuk/tools/_if.scss +0 -1
- data/node_modules/govuk-frontend/dist/govuk/tools/_image-url.import.scss +31 -0
- data/node_modules/govuk-frontend/dist/govuk/tools/_image-url.scss +9 -1
- data/node_modules/govuk-frontend/dist/govuk/tools/_index.import.scss +2 -0
- data/node_modules/govuk-frontend/dist/govuk/tools/_index.scss +6 -7
- data/node_modules/govuk-frontend/dist/govuk/tools/_px-to-em.import.scss +2 -0
- data/node_modules/govuk-frontend/dist/govuk/tools/_px-to-em.scss +1 -2
- data/node_modules/govuk-frontend/dist/govuk/tools/_px-to-rem.import.scss +2 -0
- data/node_modules/govuk-frontend/dist/govuk/tools/_px-to-rem.scss +1 -2
- data/node_modules/govuk-frontend/dist/govuk/utilities/_clearfix.import.scss +8 -0
- data/node_modules/govuk-frontend/dist/govuk/utilities/_clearfix.mixin.scss +10 -0
- data/node_modules/govuk-frontend/dist/govuk/utilities/_clearfix.scss +2 -8
- data/node_modules/govuk-frontend/dist/govuk/utilities/_index.import.scss +3 -0
- data/node_modules/govuk-frontend/dist/govuk/utilities/_index.scss +2 -4
- data/node_modules/govuk-frontend/dist/govuk/utilities/_visually-hidden.import.scss +8 -0
- data/node_modules/govuk-frontend/dist/govuk/utilities/_visually-hidden.mixin.scss +14 -0
- data/node_modules/govuk-frontend/dist/govuk/utilities/_visually-hidden.scss +2 -12
- data/node_modules/govuk-frontend/dist/govuk-prototype-kit/init.scss +2 -3
- data/package-lock.json +229 -599
- data/package.json +3 -3
- metadata +263 -74
- data/.github/workflows/publish.yaml +0 -83
- data/docs/configuration.md +0 -3
- data/docs/frontmatter.md +0 -3
- data/docs/page-expiry.md +0 -3
- data/example/.ruby-version +0 -1
- data/example/Gemfile +0 -3
- data/example/config/tech-docs.yml +0 -67
- data/example/source/active-pages/index.html.md.erb +0 -7
- data/example/source/active-pages/sub-section/index.html.md.erb +0 -7
- data/example/source/api-path.html.md +0 -7
- data/example/source/api-reference.html.md +0 -5
- data/example/source/child-of-expired-page.html.md +0 -8
- data/example/source/code.html.md +0 -42
- data/example/source/core-layout-without-sidebar.html.md.erb +0 -7
- data/example/source/core-layout.html.md.erb +0 -12
- data/example/source/expired-page-with-owner.html.md +0 -10
- data/example/source/expired-page.html.md +0 -9
- data/example/source/headings.html.md +0 -11
- data/example/source/hidden-page.html.md +0 -10
- data/example/source/index.html.md.erb +0 -27
- data/example/source/javascripts/govuk_frontend.js +0 -1
- data/example/source/nested-page/another-nested-nested-page/index.html.md +0 -5
- data/example/source/nested-page/another-nested-page/index.html.md +0 -5
- data/example/source/nested-page/index.html.md +0 -5
- data/example/source/not-expired-page.html.md +0 -9
- data/example/source/pets.yml +0 -113
- data/example/source/prevent-index-page.html.md +0 -10
- data/example/source/single-page-nav.html.md +0 -13
- data/example/source/templates/proxy_template.html.md +0 -8
- data/node_modules/govuk-frontend/dist/govuk/components/accordion/_accordion.scss +0 -7
- data/node_modules/govuk-frontend/dist/govuk/components/back-link/_back-link.scss +0 -7
- data/node_modules/govuk-frontend/dist/govuk/components/breadcrumbs/_breadcrumbs.scss +0 -7
- data/node_modules/govuk-frontend/dist/govuk/components/button/_button.scss +0 -7
- data/node_modules/govuk-frontend/dist/govuk/components/character-count/_character-count.scss +0 -7
- data/node_modules/govuk-frontend/dist/govuk/components/checkboxes/_checkboxes.scss +0 -7
- data/node_modules/govuk-frontend/dist/govuk/components/cookie-banner/_cookie-banner.scss +0 -7
- data/node_modules/govuk-frontend/dist/govuk/components/date-input/_date-input.scss +0 -7
- data/node_modules/govuk-frontend/dist/govuk/components/details/_details.scss +0 -7
- data/node_modules/govuk-frontend/dist/govuk/components/error-message/_error-message.scss +0 -7
- data/node_modules/govuk-frontend/dist/govuk/components/error-summary/_error-summary.scss +0 -7
- data/node_modules/govuk-frontend/dist/govuk/components/exit-this-page/_exit-this-page.scss +0 -7
- data/node_modules/govuk-frontend/dist/govuk/components/fieldset/_fieldset.scss +0 -7
- data/node_modules/govuk-frontend/dist/govuk/components/file-upload/_file-upload.scss +0 -7
- data/node_modules/govuk-frontend/dist/govuk/components/footer/_footer.scss +0 -7
- data/node_modules/govuk-frontend/dist/govuk/components/header/_header.scss +0 -7
- data/node_modules/govuk-frontend/dist/govuk/components/hint/_hint.scss +0 -7
- data/node_modules/govuk-frontend/dist/govuk/components/input/_input.scss +0 -7
- data/node_modules/govuk-frontend/dist/govuk/components/inset-text/_inset-text.scss +0 -7
- data/node_modules/govuk-frontend/dist/govuk/components/label/_label.scss +0 -7
- data/node_modules/govuk-frontend/dist/govuk/components/notification-banner/_notification-banner.scss +0 -7
- data/node_modules/govuk-frontend/dist/govuk/components/pagination/_pagination.scss +0 -7
- data/node_modules/govuk-frontend/dist/govuk/components/panel/_panel.scss +0 -7
- data/node_modules/govuk-frontend/dist/govuk/components/password-input/_password-input.scss +0 -7
- data/node_modules/govuk-frontend/dist/govuk/components/phase-banner/_phase-banner.scss +0 -7
- data/node_modules/govuk-frontend/dist/govuk/components/radios/_radios.scss +0 -7
- data/node_modules/govuk-frontend/dist/govuk/components/select/_select.scss +0 -7
- data/node_modules/govuk-frontend/dist/govuk/components/service-navigation/_service-navigation.scss +0 -7
- data/node_modules/govuk-frontend/dist/govuk/components/skip-link/_skip-link.scss +0 -7
- data/node_modules/govuk-frontend/dist/govuk/components/summary-list/_summary-list.scss +0 -7
- data/node_modules/govuk-frontend/dist/govuk/components/table/_table.scss +0 -7
- data/node_modules/govuk-frontend/dist/govuk/components/tabs/_tabs.scss +0 -7
- data/node_modules/govuk-frontend/dist/govuk/components/tag/_tag.scss +0 -7
- data/node_modules/govuk-frontend/dist/govuk/components/task-list/_task-list.scss +0 -7
- data/node_modules/govuk-frontend/dist/govuk/components/textarea/_textarea.scss +0 -7
- data/node_modules/govuk-frontend/dist/govuk/components/warning-text/_warning-text.scss +0 -7
- data/node_modules/govuk-frontend/dist/govuk/settings/_colours-applied.scss +0 -10
- /data/{example → documentation}/source/javascripts/application.js +0 -0
- /data/{example → documentation}/source/stylesheets/print.css.scss +0 -0
- /data/{example → documentation}/source/stylesheets/screen-old-ie.css.scss +0 -0
- /data/{example → documentation}/source/stylesheets/screen.css.scss +0 -0
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 4bdc6cdd2fc1c883f3d0e5a3c25b3fce362207729376181436ce17d19ecf8bf0
|
|
4
|
+
data.tar.gz: 1eced113c1c927f274f513a2a84edfa5bc590e445845cf9b55af852d7ebe7fad
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: bead1914b3ad00993bcf519a1931d70463e5a22c5f3c5665355ac39e24610b027ba54dc729f47142568af2ccfc5d3192c631e56adcedaa7c14f240a8eb3eb8f8
|
|
7
|
+
data.tar.gz: cabbdfc6bb527131c71a52be3bde21545967cb6afaa3797e35612c2fcf0a513268594d9cf0a773fa2dc735082d95390546c1374634745d850e7242765f30cd42
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
name: ✨ New or updated documentation
|
|
2
|
+
description: Suggest a new feature or improvement
|
|
3
|
+
title: "[Documentation]: "
|
|
4
|
+
labels: ["documentation"]
|
|
5
|
+
body:
|
|
6
|
+
- type: checkboxes
|
|
7
|
+
id: documentation-type
|
|
8
|
+
attributes:
|
|
9
|
+
label: Is this
|
|
10
|
+
options:
|
|
11
|
+
- label: a suggestion for new content
|
|
12
|
+
required: false
|
|
13
|
+
- label: an update to existing content
|
|
14
|
+
required: false
|
|
15
|
+
- label: a suggestion to remove content
|
|
16
|
+
required: false
|
|
17
|
+
|
|
18
|
+
- type: textarea
|
|
19
|
+
id: user-need
|
|
20
|
+
attributes:
|
|
21
|
+
label: User need
|
|
22
|
+
description: Do you have evidence that the change will meet the needs of users? Let us know about any user research or testing you’ve done
|
|
23
|
+
|
|
24
|
+
- type: textarea
|
|
25
|
+
id: proposal
|
|
26
|
+
attributes:
|
|
27
|
+
label: Proposed solution
|
|
28
|
+
description: Optional — describe how you think this would look or link to a draft
|
|
29
|
+
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
name: 'Build middleman artifact'
|
|
2
|
+
on:
|
|
3
|
+
workflow_call:
|
|
4
|
+
inputs:
|
|
5
|
+
upload-artifact:
|
|
6
|
+
default: false
|
|
7
|
+
required: false
|
|
8
|
+
type: boolean
|
|
9
|
+
|
|
10
|
+
jobs:
|
|
11
|
+
build:
|
|
12
|
+
runs-on: ubuntu-latest
|
|
13
|
+
defaults:
|
|
14
|
+
run:
|
|
15
|
+
working-directory: documentation
|
|
16
|
+
steps:
|
|
17
|
+
- name: Checkout repository
|
|
18
|
+
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
|
|
19
|
+
with:
|
|
20
|
+
fetch-depth: 0
|
|
21
|
+
- name: Setup Node
|
|
22
|
+
uses: actions/setup-node@820762786026740c76f36085b0efc47a31fe5020 # v7.0.0
|
|
23
|
+
with:
|
|
24
|
+
node-version-file: 'documentation/.nvmrc'
|
|
25
|
+
- name: Setup Ruby
|
|
26
|
+
uses: ruby/setup-ruby@95ef2b042f9d7a56d8268cba8559e2842e2ad01b # v1.321.0
|
|
27
|
+
with:
|
|
28
|
+
bundler-cache: true
|
|
29
|
+
working-directory: documentation
|
|
30
|
+
ruby-version: '3'
|
|
31
|
+
- name: Install gems
|
|
32
|
+
run: bundle install
|
|
33
|
+
- name: Build
|
|
34
|
+
run: bundle exec middleman build
|
|
35
|
+
- name: Upload artifact
|
|
36
|
+
uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v4.1.3
|
|
37
|
+
if: ${{ inputs.upload-artifact }}
|
|
38
|
+
with:
|
|
39
|
+
name: build
|
|
40
|
+
path: documentation/build/**
|
|
41
|
+
retention-days: 1
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
name: check-documentation-updates
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
workflow_call:
|
|
5
|
+
outputs:
|
|
6
|
+
documentation-updated:
|
|
7
|
+
value: ${{ jobs.check-documentation-updates.outputs.documentation-updated }}
|
|
8
|
+
|
|
9
|
+
|
|
10
|
+
jobs:
|
|
11
|
+
check-documentation-updates:
|
|
12
|
+
runs-on: ubuntu-latest
|
|
13
|
+
outputs:
|
|
14
|
+
documentation-updated: ${{ steps.documentation_updated.outputs.documentation-updated }}
|
|
15
|
+
|
|
16
|
+
steps:
|
|
17
|
+
- uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
|
|
18
|
+
with:
|
|
19
|
+
show-progress: false
|
|
20
|
+
|
|
21
|
+
- uses: ruby/setup-ruby@95ef2b042f9d7a56d8268cba8559e2842e2ad01b # v1.321.0
|
|
22
|
+
with:
|
|
23
|
+
ruby-version: '3'
|
|
24
|
+
|
|
25
|
+
- name: Documentation updated
|
|
26
|
+
id: documentation_updated
|
|
27
|
+
run: |
|
|
28
|
+
if git diff --name-only ${{ github.event.before }} ${{ github.sha }} | grep -q '^documentation/'; then
|
|
29
|
+
echo "documentation-updated=true" >> $GITHUB_OUTPUT
|
|
30
|
+
else
|
|
31
|
+
echo "documentation-updated=false" >> $GITHUB_OUTPUT
|
|
32
|
+
fi
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
name: check-gem-version
|
|
2
|
+
on:
|
|
3
|
+
workflow_call:
|
|
4
|
+
outputs:
|
|
5
|
+
version-changed:
|
|
6
|
+
value: ${{ jobs.check-gem-version.outputs.version-changed }}
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
jobs:
|
|
10
|
+
check-gem-version:
|
|
11
|
+
runs-on: ubuntu-latest
|
|
12
|
+
outputs:
|
|
13
|
+
version-changed: ${{ steps.gem_version.outputs.version-changed }}
|
|
14
|
+
|
|
15
|
+
steps:
|
|
16
|
+
- uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
|
|
17
|
+
with:
|
|
18
|
+
show-progress: false
|
|
19
|
+
|
|
20
|
+
- uses: ruby/setup-ruby@95ef2b042f9d7a56d8268cba8559e2842e2ad01b # v1.321.0
|
|
21
|
+
with:
|
|
22
|
+
ruby-version: '3'
|
|
23
|
+
|
|
24
|
+
- name: Gem version changed
|
|
25
|
+
id: gem_version
|
|
26
|
+
run: |
|
|
27
|
+
gem_version=$(ruby -r rubygems -e "puts Gem::Specification::load('govuk_tech_docs.gemspec').version")
|
|
28
|
+
echo "gem_version=$gem_version" >> "$GITHUB_OUTPUT"
|
|
29
|
+
|
|
30
|
+
if git fetch origin "refs/tags/v$gem_version" >/dev/null 2>&1
|
|
31
|
+
then
|
|
32
|
+
echo "Tag 'v$gem_version' already exists"
|
|
33
|
+
echo "version-changed=false" >> "$GITHUB_OUTPUT"
|
|
34
|
+
else
|
|
35
|
+
echo "version-changed=true" >> "$GITHUB_OUTPUT"
|
|
36
|
+
fi
|
|
@@ -1,9 +1,6 @@
|
|
|
1
1
|
name: 'Dependency Review'
|
|
2
2
|
on:
|
|
3
|
-
|
|
4
|
-
branches: [ "main" ]
|
|
5
|
-
push:
|
|
6
|
-
branches: [ "main" ]
|
|
3
|
+
workflow_call:
|
|
7
4
|
|
|
8
5
|
permissions:
|
|
9
6
|
contents: read
|
|
@@ -13,7 +10,7 @@ jobs:
|
|
|
13
10
|
runs-on: ubuntu-latest
|
|
14
11
|
steps:
|
|
15
12
|
- name: 'Checkout Repository'
|
|
16
|
-
uses: actions/checkout@
|
|
13
|
+
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
|
|
17
14
|
- name: 'Dependency Review'
|
|
18
15
|
uses: actions/dependency-review-action@a1d282b36b6f3519aa1f3fc636f609c47dddb294 #5.0.0
|
|
19
16
|
with:
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
name: pipeline
|
|
2
|
+
on:
|
|
3
|
+
pull_request:
|
|
4
|
+
branches: [ "main"]
|
|
5
|
+
push:
|
|
6
|
+
branches: [ "main"]
|
|
7
|
+
|
|
8
|
+
jobs:
|
|
9
|
+
dependency-review:
|
|
10
|
+
uses: ./.github/workflows/dependency-review.yaml
|
|
11
|
+
permissions:
|
|
12
|
+
contents: read
|
|
13
|
+
|
|
14
|
+
test:
|
|
15
|
+
needs: dependency-review
|
|
16
|
+
uses: ./.github/workflows/test.yaml
|
|
17
|
+
permissions:
|
|
18
|
+
contents: read # Allows the action to check out your repository code
|
|
19
|
+
pull-requests: write # Allows the action to comment on or update the Dependabot PR
|
|
20
|
+
statuses: write # Allows the action to post pass/fail build statuses
|
|
21
|
+
|
|
22
|
+
check-gem-version:
|
|
23
|
+
needs: test
|
|
24
|
+
uses: ./.github/workflows/check-gem-version.yaml
|
|
25
|
+
|
|
26
|
+
publish-gem:
|
|
27
|
+
needs: check-gem-version
|
|
28
|
+
if: github.event_name == 'push' && needs.check-gem-version.outputs.version-changed == 'true'
|
|
29
|
+
with:
|
|
30
|
+
new-gem-version: true
|
|
31
|
+
uses: ./.github/workflows/publish-gem.yaml
|
|
32
|
+
permissions:
|
|
33
|
+
contents: write # needed to be able to tag the release
|
|
34
|
+
|
|
35
|
+
check-documentation-updates:
|
|
36
|
+
needs: publish-gem
|
|
37
|
+
if: |
|
|
38
|
+
github.event_name == 'push' &&
|
|
39
|
+
always() &&
|
|
40
|
+
(needs.publish-gem.result == 'success' || needs.publish-gem.result == 'skipped')
|
|
41
|
+
uses: ./.github/workflows/check-documentation-updates.yaml
|
|
42
|
+
|
|
43
|
+
publish-github-pages:
|
|
44
|
+
needs: check-documentation-updates
|
|
45
|
+
if: github.event_name == 'push' && needs.check-documentation-updates.outputs.documentation-updated == 'true'
|
|
46
|
+
uses: ./.github/workflows/publish-github-pages.yaml
|
|
47
|
+
permissions:
|
|
48
|
+
contents: read
|
|
49
|
+
pages: write
|
|
50
|
+
id-token: write
|
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
name: Publish
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
workflow_call:
|
|
5
|
+
inputs:
|
|
6
|
+
new-gem-version:
|
|
7
|
+
default: false
|
|
8
|
+
type: boolean
|
|
9
|
+
|
|
10
|
+
workflow_dispatch:
|
|
11
|
+
inputs:
|
|
12
|
+
new-gem-version:
|
|
13
|
+
description: 'Force publish gem?'
|
|
14
|
+
default: false
|
|
15
|
+
type: boolean
|
|
16
|
+
|
|
17
|
+
concurrency: rubygems
|
|
18
|
+
|
|
19
|
+
jobs:
|
|
20
|
+
deploy:
|
|
21
|
+
name: Publish Ruby Gem
|
|
22
|
+
environment: rubygems
|
|
23
|
+
permissions:
|
|
24
|
+
contents: write # needed to be able to tag the release
|
|
25
|
+
runs-on: ubuntu-latest
|
|
26
|
+
if: inputs.new-gem-version
|
|
27
|
+
|
|
28
|
+
steps:
|
|
29
|
+
- uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
|
|
30
|
+
with:
|
|
31
|
+
show-progress: false
|
|
32
|
+
|
|
33
|
+
- uses: actions/setup-node@820762786026740c76f36085b0efc47a31fe5020 # v7.0.0
|
|
34
|
+
with:
|
|
35
|
+
node-version-file: '.nvmrc'
|
|
36
|
+
cache: 'npm'
|
|
37
|
+
|
|
38
|
+
- uses: ruby/setup-ruby@95ef2b042f9d7a56d8268cba8559e2842e2ad01b # v1.321.0
|
|
39
|
+
with:
|
|
40
|
+
ruby-version: '3'
|
|
41
|
+
bundler-cache: true
|
|
42
|
+
|
|
43
|
+
- name: Publish
|
|
44
|
+
env:
|
|
45
|
+
RUBYGEMS_API_KEY: ${{ secrets.RUBYGEMS_API_KEY }}
|
|
46
|
+
run: |
|
|
47
|
+
mkdir -p ~/.gem
|
|
48
|
+
|
|
49
|
+
cat << EOF > ~/.gem/credentials
|
|
50
|
+
---
|
|
51
|
+
:rubygems_api_key: ${RUBYGEMS_API_KEY}
|
|
52
|
+
EOF
|
|
53
|
+
|
|
54
|
+
chmod 0600 ~/.gem/credentials
|
|
55
|
+
|
|
56
|
+
# tag will be associated with github-actions bot user, see
|
|
57
|
+
# https://github.community/t/github-actions-bot-email-address/17204
|
|
58
|
+
git config user.name "github-actions[bot]"
|
|
59
|
+
git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
|
|
60
|
+
|
|
61
|
+
bundle exec rake release
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
name: Publish GitHub pages
|
|
2
|
+
on:
|
|
3
|
+
workflow_call:
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
permissions:
|
|
7
|
+
contents: read
|
|
8
|
+
pages: write
|
|
9
|
+
id-token: write
|
|
10
|
+
|
|
11
|
+
concurrency:
|
|
12
|
+
group: "pages"
|
|
13
|
+
cancel-in-progress: false
|
|
14
|
+
|
|
15
|
+
jobs:
|
|
16
|
+
build:
|
|
17
|
+
uses: ./.github/workflows/build-middleman-artifact.yaml
|
|
18
|
+
with:
|
|
19
|
+
upload-artifact: true
|
|
20
|
+
deploy-to-pages:
|
|
21
|
+
needs: build
|
|
22
|
+
environment:
|
|
23
|
+
name: github-pages
|
|
24
|
+
url: ${{ steps.deployment.outputs.page_url }}
|
|
25
|
+
runs-on: ubuntu-latest
|
|
26
|
+
steps:
|
|
27
|
+
- name: Download build artifact
|
|
28
|
+
uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c #v8.0.1
|
|
29
|
+
with:
|
|
30
|
+
name: build
|
|
31
|
+
path: build
|
|
32
|
+
- name: Upload artifact
|
|
33
|
+
uses: actions/upload-pages-artifact@fc324d3547104276b827a68afc52ff2a11cc49c9 #v5.0.0
|
|
34
|
+
with:
|
|
35
|
+
path: "build"
|
|
36
|
+
- name: Deploy to GitHub Pages
|
|
37
|
+
id: deployment
|
|
38
|
+
uses: actions/deploy-pages@cd2ce8fcbc39b97be8ca5fce6e763baed58fa128 # v5.0.0
|
data/.github/workflows/test.yaml
CHANGED
|
@@ -1,40 +1,47 @@
|
|
|
1
1
|
name: Test
|
|
2
2
|
|
|
3
3
|
on:
|
|
4
|
-
|
|
5
|
-
branches: [ "main" ]
|
|
6
|
-
push:
|
|
7
|
-
branches: [ "main" ]
|
|
8
|
-
workflow_dispatch:
|
|
4
|
+
workflow_call:
|
|
9
5
|
|
|
10
6
|
permissions:
|
|
11
7
|
contents: read # Allows the action to check out your repository code
|
|
12
8
|
pull-requests: write # Allows the action to comment on or update the Dependabot PR
|
|
13
9
|
statuses: write # Allows the action to post pass/fail build statuses
|
|
14
10
|
|
|
11
|
+
concurrency:
|
|
12
|
+
group: ${{ github.workflow }}-${{ github.ref }}
|
|
13
|
+
cancel-in-progress: true
|
|
14
|
+
|
|
15
15
|
jobs:
|
|
16
16
|
test:
|
|
17
17
|
name: Test
|
|
18
18
|
runs-on: ubuntu-latest
|
|
19
19
|
|
|
20
20
|
strategy:
|
|
21
|
+
fail-fast: false
|
|
21
22
|
matrix:
|
|
22
23
|
ruby: ['3.3', '3.4', '4.0']
|
|
23
24
|
|
|
24
25
|
steps:
|
|
25
|
-
- uses: actions/checkout@
|
|
26
|
+
- uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
|
|
26
27
|
with:
|
|
27
28
|
show-progress: false
|
|
28
29
|
|
|
29
|
-
- uses: actions/setup-node@
|
|
30
|
+
- uses: actions/setup-node@820762786026740c76f36085b0efc47a31fe5020 # v7.0.0
|
|
30
31
|
with:
|
|
31
32
|
node-version-file: '.nvmrc'
|
|
32
33
|
cache: 'npm'
|
|
33
34
|
|
|
34
|
-
- uses: ruby/setup-ruby@
|
|
35
|
+
- uses: ruby/setup-ruby@95ef2b042f9d7a56d8268cba8559e2842e2ad01b # v1.321.0
|
|
35
36
|
with:
|
|
36
37
|
ruby-version: ${{ matrix.ruby }}
|
|
37
38
|
bundler-cache: true
|
|
38
39
|
|
|
39
|
-
- name:
|
|
40
|
-
run: bundle exec rake
|
|
40
|
+
- name: Lint Ruby and javascript files
|
|
41
|
+
run: bundle exec rake lint
|
|
42
|
+
|
|
43
|
+
- name: Run Ruby unit tests
|
|
44
|
+
run: bundle exec rake spec
|
|
45
|
+
|
|
46
|
+
- name: Run Javascript tests
|
|
47
|
+
run: bundle exec rake jasmine:ci
|
data/.gitignore
CHANGED
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
/test/tmp/
|
|
11
11
|
/test/version_tmp/
|
|
12
12
|
/tmp/
|
|
13
|
-
|
|
13
|
+
.idea/
|
|
14
14
|
# Used by dotenv library to load environment variables.
|
|
15
15
|
# .env
|
|
16
16
|
|
|
@@ -28,9 +28,10 @@
|
|
|
28
28
|
# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
|
|
29
29
|
.rvmrc
|
|
30
30
|
|
|
31
|
-
/
|
|
32
|
-
/
|
|
33
|
-
/
|
|
31
|
+
/spec/test-site/build
|
|
32
|
+
/spec/test-site/.bundle
|
|
33
|
+
/spec/test-site/.sass-cache
|
|
34
34
|
|
|
35
35
|
Gemfile.lock
|
|
36
36
|
node_modules
|
|
37
|
+
documentation/build/
|
data/.rspec
CHANGED
data/CHANGELOG.md
CHANGED
|
@@ -1,3 +1,16 @@
|
|
|
1
|
+
## Unreleased changes
|
|
2
|
+
|
|
3
|
+
## 6.3.1.beta
|
|
4
|
+
|
|
5
|
+
- [Remove govuk wrapper class](https://github.com/alphagov/tech-docs-gem/pull/530) that introduced extra padding
|
|
6
|
+
- Update[ template html syntax](https://github.com/alphagov/tech-docs-gem/pull/520) to more closely match gov.uk design template
|
|
7
|
+
- bump govuk-frontend from [6.2.0 to 6.3.0](https://github.com/alphagov/tech-docs-gem/pull/517)
|
|
8
|
+
|
|
9
|
+
## 6.3.0
|
|
10
|
+
|
|
11
|
+
- Bugfix [issue 258](https://github.com/alphagov/tech-docs-template/issues/258) - page layout structure to remove whitespace on short pages ([pull request 513](https://github.com/alphagov/tech-docs-gem/pull/513))
|
|
12
|
+
- [6.3.0.beta](#630beta)
|
|
13
|
+
|
|
1
14
|
## 6.3.0.beta
|
|
2
15
|
|
|
3
16
|
- Add `exe/tech_docs_jobs` to allow executable `Rake` commands
|
|
@@ -227,7 +240,7 @@ You can see more detail about this issue at [#323: Fix XSS vulnerability on sear
|
|
|
227
240
|
|
|
228
241
|
There are some steps you should follow as the Technical Documentation Template (TDT) now uses GOV.UK Frontend 4.4.1.
|
|
229
242
|
|
|
230
|
-
1. Update your documentation site to use the latest template version. You can [follow the TDT guidance on using the latest template version](https://
|
|
243
|
+
1. Update your documentation site to use the latest template version. You can [follow the TDT guidance on using the latest template version](https://alphagov.github.io/tech-docs-gem/maintain_project/use_latest_template/).
|
|
231
244
|
2. Check your documentation site displays correctly. If your site does not display correctly, you can refer to the [GOV.UK Frontend release notes](https://github.com/alphagov/govuk-frontend/releases/) for more information, or [contact the GOV.UK Design System team](https://design-system.service.gov.uk/get-in-touch/).
|
|
232
245
|
|
|
233
246
|
### Fixes
|
|
@@ -244,7 +257,7 @@ There are some steps you should follow as the Technical Documentation Template (
|
|
|
244
257
|
|
|
245
258
|
### New features
|
|
246
259
|
|
|
247
|
-
You can now [configure your Tech Docs Template (TDT) to build your documentation site to use relative links to pages and assets](https://
|
|
260
|
+
You can now [configure your Tech Docs Template (TDT) to build your documentation site to use relative links to pages and assets](https://alphagov.github.io/tech-docs-gem/configure_project/global_configuration/#build-your-site-using-relative-links).
|
|
248
261
|
|
|
249
262
|
Thanks [@eddgrant](https://github.com/eddgrant) for contributing this feature and the associated fixes.
|
|
250
263
|
|
|
@@ -256,7 +269,7 @@ This change was introduced in [pull request #291: Support sites deployed on path
|
|
|
256
269
|
|
|
257
270
|
There are some steps you should follow as the Technical Documentation Template (TDT) now uses GOV.UK Frontend 4.0.0.
|
|
258
271
|
|
|
259
|
-
1. Update your documentation site to use the latest template version. You can [follow the TDT guidance on using the latest template version](https://
|
|
272
|
+
1. Update your documentation site to use the latest template version. You can [follow the TDT guidance on using the latest template version](https://alphagov.github.io/tech-docs-gem/maintain_project/use_latest_template/).
|
|
260
273
|
2. Check your documentation site displays correctly. If your site does not display correctly, you can refer to the [GOV.UK Frontend 4.0.0 release note](https://github.com/alphagov/govuk-frontend/releases/tag/v4.0.0) for more information.
|
|
261
274
|
|
|
262
275
|
## 3.0.1
|
|
@@ -465,7 +478,7 @@ Fixes bug where search results disappear when opening results in a new tab, maki
|
|
|
465
478
|
|
|
466
479
|
Adds a `show_expiry` config option to allow you to choose whether to show the review due date and expired banner from your pages. Find out more about the [page expiry and review feature][expiry].
|
|
467
480
|
|
|
468
|
-
[expiry]: https://
|
|
481
|
+
[expiry]: https://alphagov.github.io/tech-docs-gem/page-expiry.html#page-expiry-and-review
|
|
469
482
|
|
|
470
483
|
## 1.8.1
|
|
471
484
|
|
data/README.md
CHANGED
|
@@ -11,7 +11,7 @@ the [Tech Docs Template documentation][tdt-docs].
|
|
|
11
11
|
|
|
12
12
|
Everybody who uses this project is encouraged to contribute.
|
|
13
13
|
|
|
14
|
-
Find out how to [contribute](https://
|
|
14
|
+
Find out how to [contribute](https://alphagov.github.io/tech-docs-gem/support/#contribute).
|
|
15
15
|
|
|
16
16
|
## Rake tasks
|
|
17
17
|
|
|
@@ -52,7 +52,7 @@ the [GOV.UK Design System](https://design-system.service.gov.uk/).
|
|
|
52
52
|
|
|
53
53
|
This gem can also use [GOV.UK Design System nunjucks components](https://design-system.service.gov.uk/components/). It
|
|
54
54
|
is recommended that you use these as they are user researched and accessibility tested. An example using the
|
|
55
|
-
`govukButton` component is available in the [example site in this gem](
|
|
55
|
+
`govukButton` component is available in the [example site in this gem](spec/example/source/index.html.md.erb).
|
|
56
56
|
|
|
57
57
|
We use `npm` to download the govuk-frontend package. To update to a new version, change the version in
|
|
58
58
|
the [package.json file](package.json) and run `npm update`.
|
|
@@ -122,7 +122,7 @@ resources will also be included.
|
|
|
122
122
|
There are 2 ways to develop with this gem. You can see your changes on either:
|
|
123
123
|
|
|
124
124
|
- your own Tech Docs Template website
|
|
125
|
-
- the
|
|
125
|
+
- the documentation in this repository
|
|
126
126
|
|
|
127
127
|
### Use your own Tech Docs Template website
|
|
128
128
|
|
|
@@ -133,17 +133,17 @@ gem 'govuk_tech_docs', path: '../tech-docs-gem'
|
|
|
133
133
|
```
|
|
134
134
|
|
|
135
135
|
To preview your documentation changes locally, see
|
|
136
|
-
the [Tech Docs Template documentation on previewing your documentation](https://
|
|
136
|
+
the [Tech Docs Template documentation on previewing your documentation](https://alphagov.github.io/tech-docs-gem/create_project/preview/#preview-your-documentation).
|
|
137
137
|
|
|
138
138
|
If you experience [the FFI gem issue for Mojave users](https://github.com/alphagov/tech-docs-gem/issues/254), you should
|
|
139
139
|
refer to this [list of possible fixes](#issue-with-ffi-on-osx-mohave).
|
|
140
140
|
|
|
141
|
-
### Use the
|
|
141
|
+
### Use the documentation in this repo
|
|
142
142
|
|
|
143
|
-
To start the
|
|
143
|
+
To start the documentation in this repo, run:
|
|
144
144
|
|
|
145
145
|
```sh
|
|
146
|
-
cd
|
|
146
|
+
cd documentation
|
|
147
147
|
bundle install
|
|
148
148
|
bundle exec middleman server
|
|
149
149
|
```
|
|
@@ -154,7 +154,7 @@ If you experience [the FFI gem issue for Mojave users](https://github.com/alphag
|
|
|
154
154
|
refer to this [list of possible fixes](#issue-with-ffi-on-osx-mohave).
|
|
155
155
|
|
|
156
156
|
For more information on previewing your documentation locally, see
|
|
157
|
-
the [Tech Docs template documentation on previewing your documentation](https://
|
|
157
|
+
the [Tech Docs template documentation on previewing your documentation](https://alphagov.github.io/tech-docs-gem/create_project/preview/#preview-your-documentation).
|
|
158
158
|
|
|
159
159
|
## Tests
|
|
160
160
|
|
|
@@ -163,7 +163,7 @@ the [Tech Docs template documentation on previewing your documentation](https://
|
|
|
163
163
|
You can run the Ruby test suite with the following command:
|
|
164
164
|
|
|
165
165
|
```shell
|
|
166
|
-
bundle exec
|
|
166
|
+
bundle exec rake spec
|
|
167
167
|
```
|
|
168
168
|
|
|
169
169
|
To test a specific file include the filepath after `rspec`.
|
|
@@ -237,7 +237,7 @@ licence.
|
|
|
237
237
|
|
|
238
238
|
[ogl]: http://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/
|
|
239
239
|
|
|
240
|
-
[tdt-docs]: https://github.
|
|
240
|
+
[tdt-docs]: https://alphagov.github.io/tech-docs-gem/
|
|
241
241
|
|
|
242
242
|
[tdt-template]: https://github.com/alphagov/tech-docs-template
|
|
243
243
|
|
data/Rakefile
CHANGED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
20
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
source "https://rubygems.org"
|
|
2
|
+
|
|
3
|
+
# For faster file watcher updates on Windows:
|
|
4
|
+
gem "wdm", "~> 0.1.0", platforms: %i[mswin mingw]
|
|
5
|
+
|
|
6
|
+
# Windows does not come with time zone data
|
|
7
|
+
gem "tzinfo-data", platforms: %i[mswin mingw jruby]
|
|
8
|
+
|
|
9
|
+
gem "govuk_tech_docs", path: ".."
|
|
10
|
+
|
|
11
|
+
gem "middleman-gh-pages"
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2018 Crown Copyright (Government Digital Service)
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# Tech Docs Template Documentation
|
|
2
|
+
|
|
3
|
+
This directory contains the documentation for the [`tech-docs-template`](https://github.com/alphagov/tech-docs-template), which uses the gem in this repository.
|
|
4
|
+
|
|
5
|
+
The documentation covers:
|
|
6
|
+
|
|
7
|
+
- creating and updating a site with the tech docs template
|
|
8
|
+
- examples of how to use the gem helpers
|
|
9
|
+
|
|
10
|
+
To start the documentation in this repo, run:
|
|
11
|
+
|
|
12
|
+
```sh
|
|
13
|
+
cd documentation
|
|
14
|
+
bundle install
|
|
15
|
+
bundle exec middleman server
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
## Publishing changes
|
|
19
|
+
|
|
20
|
+
GitHub Actions automatically publishes changes merged into the main branch of this repository to [https://alphagov.github.io/tech-docs-gem/](https://alphagov.github.io/tech-docs-gem/).
|
|
21
|
+
|
|
22
|
+
## Code of conduct
|
|
23
|
+
|
|
24
|
+
Refer to the `alphagov` [code of conduct](https://github.com/alphagov/code-of-conduct).
|
|
25
|
+
|
|
26
|
+
## Licence
|
|
27
|
+
|
|
28
|
+
Unless stated otherwise, the codebase is released under the [MIT License](LICENSE). This covers both the codebase and any sample code in the documentation.
|
|
29
|
+
|
|
30
|
+
The documentation is [© Crown copyright](http://www.nationalarchives.gov.uk/information-management/re-using-public-sector-information/copyright-and-re-use/crown-copyright/) and available under the terms of the [Open Government 3.0 licence](https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/).
|