Merge pull request #343 from Financial-Times/matth/move-x-docs

Move documentation website into separate folder

Author: i-like-robots

.circleci/config.yml

@@ -26,7 +26,7 @@ references:
 
   cache_keys_docs: &cache_keys_docs
     keys:
-      - cache-docs-v1-{{ .Branch }}-{{ checksum "./tools/x-docs/package.json" }}
+      - cache-docs-v1-{{ .Branch }}-{{ checksum "./web/package.json" }}
 
   #
   # Cache creation
@@ -39,9 +39,9 @@ references:
 
   create_cache_docs: &create_cache_docs
     save_cache:
-      key: cache-docs-v1-{{ .Branch }}-{{ checksum "./tools/x-docs/package.json" }}
+      key: cache-docs-v1-{{ .Branch }}-{{ checksum "./web/package.json" }}
       paths:
-        - ./tools/x-docs/node_modules/
+        - ./web/node_modules/
 
   #
   # Cache restoration
@@ -93,15 +93,13 @@ jobs:
           name: Checkout next-ci-shared-helpers
           command: git clone --depth 1 [email protected]:Financial-Times/next-ci-shared-helpers.git .circleci/shared-helpers
       - *restore_cache_root
-      - *restore_cache_docs
       - run:
           name: Install project dependencies
           command: make install
       - run:
           name: Run the project build task
           command: make build
       - *create_cache_root
-      - *create_cache_docs
       - persist_to_workspace:
           root: *workspace_root
           paths:
@@ -162,6 +160,14 @@ jobs:
       - add_ssh_keys:
           fingerprints:
             - "2b:98:17:21:34:bf:5d:3b:15:a5:82:77:90:11:03:e9"
+      - *restore_cache_docs
+      - run:
+          name: Install documentation website dependencies
+          command: npm run install-docs
+      - *create_cache_docs
+      - run:
+          name: Build documentation website
+          command: npm run build-docs
       - run:
           name: Publish GitHub Pages
           command: ./private/scripts/gh-pages

.eslintignore

@@ -6,4 +6,4 @@
 **/public/**
 **/public-prod/**
 **/blueprints/**
-tools/x-docs/static/**
+web/static/**

docs/get-started/working-with-x-dash.md

@@ -11,7 +11,9 @@
     "blueprint": "node private/scripts/blueprint.js",
     "start-storybook": "start-storybook -p ${STORYBOOK_PORT:-9001} -s .storybook/static -h local.ft.com",
     "build-storybook": "build-storybook -o dist/storybook -s .storybook/static",
-    "start-docs": "(cd tools/x-docs && npm start)",
+    "install-docs": "(cd web && npm install)",
+    "start-docs": "(cd web && npm start)",
+    "build-docs": "(cd web && npm build)",
     "heroku-postbuild": "make install && npm run build",
     "prepare": "npx snyk protect || npx snyk protect -d || true"
   },

package.json

@@ -1,6 +1,6 @@
 #!/usr/bin/env bash
 
-TARGET_DIR=tools/x-docs/public/*
+TARGET_DIR=web/public/*
 TARGET_BRANCH=gh-pages
 TEMP_DIR=tmp
 

private/scripts/gh-pages

@@ -0,0 +1 @@
+package-lock=false

tools/x-docs/static/storybook

@@ -19,14 +19,14 @@ module.exports = {
 			resolve: 'gatsby-source-filesystem',
 			options: {
 				name: 'docs',
-				path: '../../docs'
+				path: '../docs'
 			},
 		},
 		{
 			resolve: 'gatsby-source-filesystem',
 			options: {
 				name: 'components',
-				path: '../../components',
+				path: '../components',
 				// Don't attempt to load any Storybook or source files, as these may
 				// contain syntax and/or features we cannot parse.
 				ignore: [/stories/, /src/]
@@ -36,7 +36,7 @@ module.exports = {
 			resolve: 'gatsby-source-filesystem',
 			options: {
 				name: 'packages',
-				path: '../../packages'
+				path: '../packages'
 			},
 		},
 		// Handles markdown files (creates "MarkdownRemark" nodes)