feature(decap-cms): Configure Decap CMS to monitor key documents

Tailors Decap CMS to work with the tech doc stack, specifically targeting the following folders: - Before Integrating - Configuration for Production - Integrate with Integration environment - Test your Integration - Pages stored in the root directory This is likely a good starter for 10 to demonstrate what's possible, but may not be the full scope of what we'd want decap to support
govuk-one-login · Nov 28, 2024 · 4f5e10a · 4f5e10a
1 parent 052c89c
commit 4f5e10a
Show file tree

Hide file tree

Showing 2 changed files with 65 additions and 3 deletions.
diff --git a/source/config.yml b/source/config.yml
@@ -0,0 +1,65 @@
+---
+publish_mode: editorial_workflow
+site_url: https://docs.sign-in.service.gov.uk/
+backend:
+  name: github
+  repo: govuk-one-login/tech-docs
+  branch: main
+media_folder: "/source/images"
+public_folder: "/source/public"
+collections:
+  - name: before-integrating
+    label: Before Integrating
+    folder: source/before-integrating
+    extension: .md.erb
+    format: yaml-frontmatter
+    fields:
+      - { label: 'Title', name: 'title', widget: 'string' }
+      - { label: 'Weight', name: 'weight', widget: 'string' }
+      - { label: 'Last Review Date', name: 'last_reviewed_on', widget: 'string' }
+      - { label: 'Next Review Period', name: 'review_in', widget: 'string' }
+      - { label: 'Body', name: 'body', widget: 'markdown' }
+  - name: configure-for-production
+    label: Configuration for Production
+    folder: source/configure-for-production
+    extension: .md.erb
+    format: yaml-frontmatter
+    fields:
+      - { label: 'Title', name: 'title', widget: 'string' }
+      - { label: 'Weight', name: 'weight', widget: 'string' }
+      - { label: 'Last Review Date', name: 'last_reviewed_on', widget: 'string' }
+      - { label: 'Next Review Period', name: 'review_in', widget: 'string' }
+      - { label: 'Body', name: 'body', widget: 'markdown' }
+  - name: integrate-with-integration-environment
+    label: Integrate with Integration environment
+    folder: source/integrate-with-integration-environment
+    extension: .md.erb
+    format: yaml-frontmatter
+    fields:
+      - { label: 'Title', name: 'title', widget: 'string' }
+      - { label: 'Weight', name: 'weight', widget: 'string' }
+      - { label: 'Last Review Date', name: 'last_reviewed_on', widget: 'string' }
+      - { label: 'Next Review Period', name: 'review_in', widget: 'string' }
+      - { label: 'Body', name: 'body', widget: 'markdown' }
+  - name: test-your-integration
+    label: Test your integration
+    folder: source/test-your-integration
+    extension: .md.erb
+    format: yaml-frontmatter
+    fields:
+      - { label: 'Title', name: 'title', widget: 'string' }
+      - { label: 'Weight', name: 'weight', widget: 'string' }
+      - { label: 'Last Review Date', name: 'last_reviewed_on', widget: 'string' }
+      - { label: 'Next Review Period', name: 'review_in', widget: 'string' }
+      - { label: 'Body', name: 'body', widget: 'markdown' }
+  - name: pages
+    label: Pages
+    folder: source/
+    extension: .md.erb
+    format: yaml-frontmatter
+    fields:
+      - { label: 'Title', name: 'title', widget: 'string' }
+      - { label: 'Weight', name: 'weight', widget: 'string' }
+      - { label: 'Last Review Date', name: 'last_reviewed_on', widget: 'string' }
+      - { label: 'Next Review Period', name: 'review_in', widget: 'string' }
+      - { label: 'Body', name: 'body', widget: 'markdown' }
diff --git a/source/editor.html.md b/source/editor.html.md
@@ -14,9 +14,6 @@ hide_in_navigation: true
 
 <body>
   <script src="https://unpkg.com/decap-cms@^3.0.0/dist/decap-cms.js"></script>
-  <script>
-    CMS.registerPreviewStyle("manifest.css");
-  </script>
 </body>
 
 </html>