Extract core pipeline stages into its own package

atlassian-archive · Jan 14, 2020 · 7f22b53 · 7f22b53
1 parent b29663f
commit 7f22b53
Show file tree

Hide file tree

Showing 148 changed files with 184 additions and 40 deletions.
diff --git a/package.json b/package.json
@@ -37,7 +37,8 @@
     "packages": [
       "packages/file-viewer",
       "packages/react-changelogs",
-      "packages/gatsby-generator"
+      "packages/gatsby-generator",
+      "packages/pipeline-stages"
     ]
   },
   "dependencies": {

diff --git a/packages/gatsby-generator/docs/build-pipeline/4-build-website-stage.md b/packages/gatsby-generator/docs/build-pipeline/4-build-website-stage.md
diff --git a/packages/gatsby-generator/docs/build-pipeline/5-start-website-stage.md b/packages/gatsby-generator/docs/build-pipeline/5-start-website-stage.md
diff --git a/packages/gatsby-generator/package.json b/packages/gatsby-generator/package.json
@@ -35,7 +35,6 @@
   },
   "files": [
     "static",
-    "default-pages",
     "babel.config.js",
     "gatsby-node.js",
     "gatsby-config.js",
@@ -66,6 +65,7 @@
     "@babel/preset-react": "^7.0.0",
     "@babel/runtime": "^7.4.3",
     "@brisk-docs/file-viewer": "^0.2.5",
+    "@brisk-docs/pipeline-stages": "^0.1.0",
     "@brisk-docs/react-changelogs": "^0.1.11",
     "@emotion/core": "^10.0.9",
     "@emotion/styled": "^10.0.9",

diff --git a/packages/gatsby-generator/src/pipeline/buildPagesPipeline.ts b/packages/gatsby-generator/src/pipeline/buildPagesPipeline.ts
@@ -1,23 +1,26 @@
-import scanMetadata from './stages/scan-metadata';
-import generateWebsiteInfo from './stages/generate-website-info';
-import generatePages from './stages/generate-pages';
+import {
+  scanMetadataStage,
+  generateWebsiteInfoStage,
+  generatePagesStage,
+} from '@brisk-docs/pipeline-stages';
+
 import allPaths from './getAllPaths';
 
 const buildPipeline = async (configPath?: string) => {
   const { rootPath, wrappersPath, pagesPath, pkgRoot, config } = await allPaths(
     configPath,
   );
 
-  return scanMetadata({
+  return scanMetadataStage({
     rootPath,
     packagePathPatterns: config.packagesPaths,
     customPackageFields: config.customPackageFields,
     docs: config.docs,
     showSubExamples: config.showSubExamples,
   })
-    .then(projectData => generateWebsiteInfo(projectData))
+    .then(projectData => generateWebsiteInfoStage(projectData))
     .then(websiteInfo =>
-      generatePages({
+      generatePagesStage({
         wrappersPath,
         pagesPath,
         packageRoot: pkgRoot,

diff --git a/packages/gatsby-generator/src/pipeline/buildPipeline.ts b/packages/gatsby-generator/src/pipeline/buildPipeline.ts
@@ -1,8 +1,10 @@
 import path from 'path';
 import fs from 'fs-extra';
-import scanMetadata from './stages/scan-metadata';
-import generateWebsiteInfo from './stages/generate-website-info';
-import generatePages from './stages/generate-pages';
+import {
+  scanMetadataStage,
+  generateWebsiteInfoStage,
+  generatePagesStage,
+} from '@brisk-docs/pipeline-stages';
 import runGatsby from './stages/run-gatsby';
 import allPaths from './getAllPaths';
 
@@ -15,16 +17,16 @@ const buildPipeline = async (
     configPath,
   );
 
-  return scanMetadata({
+  return scanMetadataStage({
     rootPath,
     packagePathPatterns: config.packagesPaths,
     customPackageFields: config.customPackageFields,
     docs: config.docs,
     showSubExamples: config.showSubExamples,
   })
-    .then(projectData => generateWebsiteInfo(projectData))
+    .then(projectData => generateWebsiteInfoStage(projectData))
     .then(websiteInfo =>
-      generatePages({
+      generatePagesStage({
         wrappersPath,
         pagesPath,
         packageRoot: pkgRoot,

diff --git a/packages/gatsby-generator/src/pipeline/devPipeline.ts b/packages/gatsby-generator/src/pipeline/devPipeline.ts
@@ -1,6 +1,8 @@
-import scanMetadata from './stages/scan-metadata';
-import generateWebsiteInfo from './stages/generate-website-info';
-import generatePages from './stages/generate-pages';
+import {
+  scanMetadataStage,
+  generateWebsiteInfoStage,
+  generatePagesStage,
+} from '@brisk-docs/pipeline-stages';
 import runGatsby from './stages/run-gatsby';
 import allPaths from './getAllPaths';
 
@@ -9,16 +11,16 @@ const devPipeline = async (configPath?: string, gatsbyOptions?: string[]) => {
     configPath,
   );
 
-  return scanMetadata({
+  return scanMetadataStage({
     rootPath,
     packagePathPatterns: config.packagesPaths,
     customPackageFields: config.customPackageFields,
     docs: config.docs,
     showSubExamples: config.showSubExamples,
   })
-    .then(projectData => generateWebsiteInfo(projectData))
+    .then(projectData => generateWebsiteInfoStage(projectData))
     .then(websiteInfo =>
-      generatePages({
+      generatePagesStage({
         wrappersPath,
         pagesPath,
         packageRoot: pkgRoot,

diff --git a/packages/gatsby-generator/src/pipeline/stages/build-website/index.ts b/packages/gatsby-generator/src/pipeline/stages/build-website/index.ts
@@ -1,4 +1,4 @@
-import createStage from '../make-pipeline-stage';
+import { makePipelineStage } from '@brisk-docs/pipeline-stages';
 // @ts-ignore
 import createNextServer from '../run-website/next-server';
 
@@ -10,7 +10,7 @@ interface StageInput {
   nextOptions?: string[];
 }
 
-export default createStage(
+export default makePipelineStage(
   'build-website',
   async (input: StageInput): Promise<void> => {
     return createNextServer(input);

diff --git a/packages/gatsby-generator/src/pipeline/stages/run-gatsby/index.ts b/packages/gatsby-generator/src/pipeline/stages/run-gatsby/index.ts
@@ -1,4 +1,4 @@
-import createStage from '../make-pipeline-stage';
+import { makePipelineStage } from '@brisk-docs/pipeline-stages';
 
 // @ts-ignore: Importing non-ts file with no definition
 import createGatsbyServer from './gatsby-server';
@@ -14,7 +14,7 @@ interface StageInput {
 // Boilerplate, uncomment when used
 // interface StageConfig {}
 
-export default createStage(
+export default makePipelineStage(
   'run-gatsby',
   async (input: StageInput): Promise<void> => createGatsbyServer(input),
 );
diff --git a/packages/gatsby-generator/src/pipeline/stages/run-website/index.ts b/packages/gatsby-generator/src/pipeline/stages/run-website/index.ts
@@ -1,4 +1,4 @@
-import createStage from '../make-pipeline-stage';
+import { makePipelineStage } from '@brisk-docs/pipeline-stages';
 
 // @ts-ignore: Importing non-ts file with no definition
 import createNextServer from './next-server';
@@ -14,7 +14,7 @@ interface StageInput {
 // Boilerplate, uncomment when used
 // interface StageConfig {}
 
-export default createStage(
+export default makePipelineStage(
   'run-website',
   async (input: StageInput): Promise<void> => {
     createNextServer(input);

diff --git a/packages/pipeline-stages/README.md b/packages/pipeline-stages/README.md
@@ -0,0 +1,13 @@
+# Brisk Docs Core Pipeline
+
+This library contains the core modules that Brisk Docs uses to read docs from a monorepo and generate the code for
+pages in the docs website.
+
+Brisk's website generation functionality is broken down into a series of stages that can be run independently or in a
+complete pipeline. This package exposes the following stages:
+
+ - Scan metadata: Scans the source of a monorepo and extract information about packages and docs within
+ - Generate website info: Creates a plan for the structure of the docs website using provided metadata
+ - Generate pages: Writes files to disk for all the pages to be built into the running website
+
+For creating and running a docs website end to end please use `@brisk-docs/gatsby-generator`.
diff --git a/...ixtures__/docs-with-readme/docs/derpo.jpg → ...ixtures__/docs-with-readme/docs/derpo.jpg b/...ixtures__/docs-with-readme/docs/derpo.jpg → ...ixtures__/docs-with-readme/docs/derpo.jpg
diff --git a/...fixtures__/docs-with-readme/docs/doc-1.md → ...fixtures__/docs-with-readme/docs/doc-1.md b/...fixtures__/docs-with-readme/docs/doc-1.md → ...fixtures__/docs-with-readme/docs/doc-1.md
diff --git a/...fixtures__/docs-with-readme/docs/doc-2.md → ...fixtures__/docs-with-readme/docs/doc-2.md b/...fixtures__/docs-with-readme/docs/doc-2.md → ...fixtures__/docs-with-readme/docs/doc-2.md
diff --git a/...-with-readme/docs/doc-3/doc-3-2/README.md → ...-with-readme/docs/doc-3/doc-3-2/README.md b/...-with-readme/docs/doc-3/doc-3-2/README.md → ...-with-readme/docs/doc-3/doc-3-2/README.md
diff --git a/...s__/docs-with-readme/docs/doc-3/readme.md → ...s__/docs-with-readme/docs/doc-3/readme.md b/...s__/docs-with-readme/docs/doc-3/readme.md → ...s__/docs-with-readme/docs/doc-3/readme.md
diff --git a/...ck-docs-with-assets/docs/_assets/doc-3.md → ...ck-docs-with-assets/docs/_assets/doc-3.md b/...ck-docs-with-assets/docs/_assets/doc-3.md → ...ck-docs-with-assets/docs/_assets/doc-3.md
diff --git a/...res__/mock-docs-with-assets/docs/doc-2.md → ...res__/mock-docs-with-assets/docs/doc-2.md b/...res__/mock-docs-with-assets/docs/doc-2.md → ...res__/mock-docs-with-assets/docs/doc-2.md
diff --git a/...ock-docs-with-assets/docs/resources/1.png → ...ock-docs-with-assets/docs/resources/1.png b/...ock-docs-with-assets/docs/resources/1.png → ...ock-docs-with-assets/docs/resources/1.png
diff --git a/...k-docs-with-assets/docs/sub-docs/doc-1.md → ...k-docs-with-assets/docs/sub-docs/doc-1.md b/...k-docs-with-assets/docs/sub-docs/doc-1.md → ...k-docs-with-assets/docs/sub-docs/doc-1.md
diff --git a/...es__/mock-docs-with-sorting/docs/doc-1.md → ...es__/mock-docs-with-sorting/docs/doc-1.md b/...es__/mock-docs-with-sorting/docs/doc-1.md → ...es__/mock-docs-with-sorting/docs/doc-1.md
diff --git a/...es__/mock-docs-with-sorting/docs/doc-2.md → ...es__/mock-docs-with-sorting/docs/doc-2.md b/...es__/mock-docs-with-sorting/docs/doc-2.md → ...es__/mock-docs-with-sorting/docs/doc-2.md
diff --git a/...k-docs-with-sorting/docs/doc-3/doc-3-1.md → ...k-docs-with-sorting/docs/doc-3/doc-3-1.md b/...k-docs-with-sorting/docs/doc-3/doc-3-1.md → ...k-docs-with-sorting/docs/doc-3/doc-3-1.md
diff --git a/...h-sorting/docs/doc-3/doc-3-2/doc-3-2-1.md → ...h-sorting/docs/doc-3/doc-3-2/doc-3-2-1.md b/...h-sorting/docs/doc-3/doc-3-2/doc-3-2-1.md → ...h-sorting/docs/doc-3/doc-3-2/doc-3-2-1.md
diff --git a/...cs-with-sorting/docs/doc-3/docs.config.js → ...cs-with-sorting/docs/doc-3/docs.config.js b/...cs-with-sorting/docs/doc-3/docs.config.js → ...cs-with-sorting/docs/doc-3/docs.config.js
diff --git a/...ock-docs-with-sorting/docs/docs.config.js → ...ock-docs-with-sorting/docs/docs.config.js b/...ock-docs-with-sorting/docs/docs.config.js → ...ock-docs-with-sorting/docs/docs.config.js
diff --git a/...packages/packages/mock-package2/README.md → ...packages/packages/mock-package2/README.md b/...packages/packages/mock-package2/README.md → ...packages/packages/mock-package2/README.md
diff --git a/...kages/mock-package2/docs/extended-info.md → ...kages/mock-package2/docs/extended-info.md b/...kages/mock-package2/docs/extended-info.md → ...kages/mock-package2/docs/extended-info.md
diff --git a/...es/mock-package2/docs/special-usecase.mdx → ...es/mock-package2/docs/special-usecase.mdx b/...es/mock-package2/docs/special-usecase.mdx → ...es/mock-package2/docs/special-usecase.mdx
diff --git a/...ckages/mock-package2/examples/example1.js → ...ckages/mock-package2/examples/example1.js b/...ckages/mock-package2/examples/example1.js → ...ckages/mock-package2/examples/example1.js
diff --git a/...ckages/mock-package2/examples/example2.js → ...ckages/mock-package2/examples/example2.js b/...ckages/mock-package2/examples/example2.js → ...ckages/mock-package2/examples/example2.js
diff --git a/...ckages/mock-package2/examples/example3.js → ...ckages/mock-package2/examples/example3.js b/...ckages/mock-package2/examples/example3.js → ...ckages/mock-package2/examples/example3.js
diff --git a/...kages/packages/mock-package2/package.json → ...kages/packages/mock-package2/package.json b/...kages/packages/mock-package2/package.json → ...kages/packages/mock-package2/package.json
diff --git a/...kages/packages/mock-package2/src/index.js → ...kages/packages/mock-package2/src/index.js b/...kages/packages/mock-package2/src/index.js → ...kages/packages/mock-package2/src/index.js
diff --git a/...ckages/sub-folder/mock-package1/README.md → ...ckages/sub-folder/mock-package1/README.md b/...ckages/sub-folder/mock-package1/README.md → ...ckages/sub-folder/mock-package1/README.md
diff --git a/...older/mock-package1/docs/extended-info.md → ...older/mock-package1/docs/extended-info.md b/...older/mock-package1/docs/extended-info.md → ...older/mock-package1/docs/extended-info.md
diff --git a/...ome-subdirectory/nesting-now-supported.md → ...ome-subdirectory/nesting-now-supported.md b/...ome-subdirectory/nesting-now-supported.md → ...ome-subdirectory/nesting-now-supported.md
diff --git a/...er/mock-package1/docs/special-usecase.mdx → ...er/mock-package1/docs/special-usecase.mdx b/...er/mock-package1/docs/special-usecase.mdx → ...er/mock-package1/docs/special-usecase.mdx
diff --git a/...folder/mock-package1/examples/example1.js → ...folder/mock-package1/examples/example1.js b/...folder/mock-package1/examples/example1.js → ...folder/mock-package1/examples/example1.js
diff --git a/...folder/mock-package1/examples/example2.js → ...folder/mock-package1/examples/example2.js b/...folder/mock-package1/examples/example2.js → ...folder/mock-package1/examples/example2.js
diff --git a/...folder/mock-package1/examples/example3.js → ...folder/mock-package1/examples/example3.js b/...folder/mock-package1/examples/example3.js → ...folder/mock-package1/examples/example3.js
diff --git a/...mock-package1/examples/not-an-example.txt → ...mock-package1/examples/not-an-example.txt b/...mock-package1/examples/not-an-example.txt → ...mock-package1/examples/not-an-example.txt
diff --git a/...ge1/examples/utils-please-ignore/index.js → ...ge1/examples/utils-please-ignore/index.js b/...ge1/examples/utils-please-ignore/index.js → ...ge1/examples/utils-please-ignore/index.js
diff --git a/...ges/sub-folder/mock-package1/package.json → ...ges/sub-folder/mock-package1/package.json b/...ges/sub-folder/mock-package1/package.json → ...ges/sub-folder/mock-package1/package.json
diff --git a/...ges/sub-folder/mock-package1/src/index.js → ...ges/sub-folder/mock-package1/src/index.js b/...ges/sub-folder/mock-package1/src/index.js → ...ges/sub-folder/mock-package1/src/index.js
diff --git a/...examples/packages/mock-package1/README.md → ...examples/packages/mock-package1/README.md b/...examples/packages/mock-package1/README.md → ...examples/packages/mock-package1/README.md
diff --git a/...kages/mock-package1/docs/extended-info.md → ...kages/mock-package1/docs/extended-info.md b/...kages/mock-package1/docs/extended-info.md → ...kages/mock-package1/docs/extended-info.md
diff --git a/...ome-subdirectory/nesting-now-supported.md → ...ome-subdirectory/nesting-now-supported.md b/...ome-subdirectory/nesting-now-supported.md → ...ome-subdirectory/nesting-now-supported.md
diff --git a/...es/mock-package1/docs/special-usecase.mdx → ...es/mock-package1/docs/special-usecase.mdx b/...es/mock-package1/docs/special-usecase.mdx → ...es/mock-package1/docs/special-usecase.mdx
diff --git a/...ckages/mock-package1/examples/example1.js → ...ckages/mock-package1/examples/example1.js b/...ckages/mock-package1/examples/example1.js → ...ckages/mock-package1/examples/example1.js
diff --git a/...ckages/mock-package1/examples/example2.js → ...ckages/mock-package1/examples/example2.js b/...ckages/mock-package1/examples/example2.js → ...ckages/mock-package1/examples/example2.js
diff --git a/...ckages/mock-package1/examples/example3.js → ...ckages/mock-package1/examples/example3.js b/...ckages/mock-package1/examples/example3.js → ...ckages/mock-package1/examples/example3.js
diff --git a/...mock-package1/examples/not-an-example.txt → ...mock-package1/examples/not-an-example.txt b/...mock-package1/examples/not-an-example.txt → ...mock-package1/examples/not-an-example.txt
diff --git a/...ge1/examples/utils-please-ignore/index.js → ...ge1/examples/utils-please-ignore/index.js b/...ge1/examples/utils-please-ignore/index.js → ...ge1/examples/utils-please-ignore/index.js
diff --git a/...mples/packages/mock-package1/package.json → ...mples/packages/mock-package1/package.json b/...mples/packages/mock-package1/package.json → ...mples/packages/mock-package1/package.json
diff --git a/...es/packages/mock-package1/src/examples.js → ...es/packages/mock-package1/src/examples.js b/...es/packages/mock-package1/src/examples.js → ...es/packages/mock-package1/src/examples.js
diff --git a/...mples/packages/mock-package1/src/index.js → ...mples/packages/mock-package1/src/index.js b/...mples/packages/mock-package1/src/index.js → ...mples/packages/mock-package1/src/index.js
diff --git a/...ck-package1/src/test-examples/examples.js → ...ck-package1/src/test-examples/examples.js b/...ck-package1/src/test-examples/examples.js → ...ck-package1/src/test-examples/examples.js
diff --git a/...ckages/mock-package1/src/view/examples.js → ...ckages/mock-package1/src/view/examples.js b/...ckages/mock-package1/src/view/examples.js → ...ckages/mock-package1/src/view/examples.js
diff --git a/...ock-package1/src/view/sub-dir/examples.js → ...ock-package1/src/view/sub-dir/examples.js b/...ock-package1/src/view/sub-dir/examples.js → ...ock-package1/src/view/sub-dir/examples.js
diff --git a/...ixtures__/simple-mock-docs/docs/derpo.jpg → ...ixtures__/simple-mock-docs/docs/derpo.jpg b/...ixtures__/simple-mock-docs/docs/derpo.jpg → ...ixtures__/simple-mock-docs/docs/derpo.jpg
diff --git a/...fixtures__/simple-mock-docs/docs/doc-1.md → ...fixtures__/simple-mock-docs/docs/doc-1.md b/...fixtures__/simple-mock-docs/docs/doc-1.md → ...fixtures__/simple-mock-docs/docs/doc-1.md
diff --git a/...fixtures__/simple-mock-docs/docs/doc-2.md → ...fixtures__/simple-mock-docs/docs/doc-2.md b/...fixtures__/simple-mock-docs/docs/doc-2.md → ...fixtures__/simple-mock-docs/docs/doc-2.md
diff --git a/...__/simple-mock-docs/docs/doc-3/doc-3-1.md → ...__/simple-mock-docs/docs/doc-3/doc-3-1.md b/...__/simple-mock-docs/docs/doc-3/doc-3-1.md → ...__/simple-mock-docs/docs/doc-3/doc-3-1.md
diff --git a/...mock-docs/docs/doc-3/doc-3-2/doc-3-2-1.md → ...mock-docs/docs/doc-3/doc-3-2/doc-3-2-1.md b/...mock-docs/docs/doc-3/doc-3-2/doc-3-2-1.md → ...mock-docs/docs/doc-3/doc-3-2/doc-3-2-1.md
diff --git a/...kages/packages/mock-package1/CHANGELOG.md → ...kages/packages/mock-package1/CHANGELOG.md b/...kages/packages/mock-package1/CHANGELOG.md → ...kages/packages/mock-package1/CHANGELOG.md
diff --git a/...packages/packages/mock-package1/README.md → ...packages/packages/mock-package1/README.md b/...packages/packages/mock-package1/README.md → ...packages/packages/mock-package1/README.md
diff --git a/...kages/mock-package1/docs/extended-info.md → ...kages/mock-package1/docs/extended-info.md b/...kages/mock-package1/docs/extended-info.md → ...kages/mock-package1/docs/extended-info.md
diff --git a/...ome-subdirectory/nesting-now-supported.md → ...ome-subdirectory/nesting-now-supported.md b/...ome-subdirectory/nesting-now-supported.md → ...ome-subdirectory/nesting-now-supported.md
diff --git a/...es/mock-package1/docs/special-usecase.mdx → ...es/mock-package1/docs/special-usecase.mdx b/...es/mock-package1/docs/special-usecase.mdx → ...es/mock-package1/docs/special-usecase.mdx
diff --git a/...ckages/mock-package1/examples/example1.js → ...ckages/mock-package1/examples/example1.js b/...ckages/mock-package1/examples/example1.js → ...ckages/mock-package1/examples/example1.js
diff --git a/...ckages/mock-package1/examples/example2.js → ...ckages/mock-package1/examples/example2.js b/...ckages/mock-package1/examples/example2.js → ...ckages/mock-package1/examples/example2.js
diff --git a/...ckages/mock-package1/examples/example3.js → ...ckages/mock-package1/examples/example3.js b/...ckages/mock-package1/examples/example3.js → ...ckages/mock-package1/examples/example3.js
diff --git a/...mock-package1/examples/not-an-example.txt → ...mock-package1/examples/not-an-example.txt b/...mock-package1/examples/not-an-example.txt → ...mock-package1/examples/not-an-example.txt
diff --git a/...ge1/examples/utils-please-ignore/index.js → ...ge1/examples/utils-please-ignore/index.js b/...ge1/examples/utils-please-ignore/index.js → ...ge1/examples/utils-please-ignore/index.js
diff --git a/...kages/packages/mock-package1/package.json → ...kages/packages/mock-package1/package.json b/...kages/packages/mock-package1/package.json → ...kages/packages/mock-package1/package.json
diff --git a/...kages/packages/mock-package1/src/index.js → ...kages/packages/mock-package1/src/index.js b/...kages/packages/mock-package1/src/index.js → ...kages/packages/mock-package1/src/index.js
diff --git a/...packages/packages/mock-package2/README.md → ...packages/packages/mock-package2/README.md b/...packages/packages/mock-package2/README.md → ...packages/packages/mock-package2/README.md
diff --git a/...kages/mock-package2/docs/extended-info.md → ...kages/mock-package2/docs/extended-info.md b/...kages/mock-package2/docs/extended-info.md → ...kages/mock-package2/docs/extended-info.md
diff --git a/...es/mock-package2/docs/special-usecase.mdx → ...es/mock-package2/docs/special-usecase.mdx b/...es/mock-package2/docs/special-usecase.mdx → ...es/mock-package2/docs/special-usecase.mdx
diff --git a/...ckages/mock-package2/examples/example1.js → ...ckages/mock-package2/examples/example1.js b/...ckages/mock-package2/examples/example1.js → ...ckages/mock-package2/examples/example1.js
diff --git a/...ckages/mock-package2/examples/example2.js → ...ckages/mock-package2/examples/example2.js b/...ckages/mock-package2/examples/example2.js → ...ckages/mock-package2/examples/example2.js
diff --git a/...ckages/mock-package2/examples/example3.js → ...ckages/mock-package2/examples/example3.js b/...ckages/mock-package2/examples/example3.js → ...ckages/mock-package2/examples/example3.js
diff --git a/...kages/packages/mock-package2/package.json → ...kages/packages/mock-package2/package.json b/...kages/packages/mock-package2/package.json → ...kages/packages/mock-package2/package.json
diff --git a/...kages/packages/mock-package2/src/index.js → ...kages/packages/mock-package2/src/index.js b/...kages/packages/mock-package2/src/index.js → ...kages/packages/mock-package2/src/index.js
diff --git a/...kages/mock-package3/docs/extended-info.md → ...kages/mock-package3/docs/extended-info.md b/...kages/mock-package3/docs/extended-info.md → ...kages/mock-package3/docs/extended-info.md
diff --git a/...es/mock-package3/docs/special-usecase.mdx → ...es/mock-package3/docs/special-usecase.mdx b/...es/mock-package3/docs/special-usecase.mdx → ...es/mock-package3/docs/special-usecase.mdx
diff --git a/...ckages/mock-package3/examples/example1.js → ...ckages/mock-package3/examples/example1.js b/...ckages/mock-package3/examples/example1.js → ...ckages/mock-package3/examples/example1.js
diff --git a/...ckages/mock-package3/examples/example2.js → ...ckages/mock-package3/examples/example2.js b/...ckages/mock-package3/examples/example2.js → ...ckages/mock-package3/examples/example2.js
diff --git a/...ckages/mock-package3/examples/example3.js → ...ckages/mock-package3/examples/example3.js b/...ckages/mock-package3/examples/example3.js → ...ckages/mock-package3/examples/example3.js
diff --git a/...kages/packages/mock-package3/package.json → ...kages/packages/mock-package3/package.json b/...kages/packages/mock-package3/package.json → ...kages/packages/mock-package3/package.json
diff --git a/...kages/packages/mock-package3/src/index.js → ...kages/packages/mock-package3/src/index.js b/...kages/packages/mock-package3/src/index.js → ...kages/packages/mock-package3/src/index.js
diff --git a/packages/pipeline-stages/data/packages-data.json b/packages/pipeline-stages/data/packages-data.json
@@ -0,0 +1,3 @@
+{
+  "metaData": []
+}
diff --git a/packages/pipeline-stages/data/pages-list.json b/packages/pipeline-stages/data/pages-list.json
@@ -0,0 +1,5 @@
+{
+  "packages": [],
+  "docs": [],
+  "readme": []
+}
diff --git a/packages/pipeline-stages/data/site-meta.json b/packages/pipeline-stages/data/site-meta.json
@@ -0,0 +1,5 @@
+{
+  "siteName": "",
+  "packages": {},
+  "docs": []
+}
diff --git a/...s/gatsby-generator/default-pages/_app.tsx → ...es/pipeline-stages/default-pages/_app.tsx b/...s/gatsby-generator/default-pages/_app.tsx → ...es/pipeline-stages/default-pages/_app.tsx
diff --git a/...atsby-generator/default-pages/_layout.tsx → ...pipeline-stages/default-pages/_layout.tsx b/...atsby-generator/default-pages/_layout.tsx → ...pipeline-stages/default-pages/_layout.tsx
diff --git a/...y-generator/default-pages/healthcheck.tsx → ...line-stages/default-pages/healthcheck.tsx b/...y-generator/default-pages/healthcheck.tsx → ...line-stages/default-pages/healthcheck.tsx
diff --git a/.../gatsby-generator/default-pages/index.tsx → ...s/pipeline-stages/default-pages/index.tsx b/.../gatsby-generator/default-pages/index.tsx → ...s/pipeline-stages/default-pages/index.tsx
diff --git a/...tsby-generator/default-pages/packages.tsx → ...ipeline-stages/default-pages/packages.tsx b/...tsby-generator/default-pages/packages.tsx → ...ipeline-stages/default-pages/packages.tsx
diff --git a/...s/build-pipeline/1-scan-metadata-stage.md → ...line-stages/docs/1-scan-metadata-stage.md b/...s/build-pipeline/1-scan-metadata-stage.md → ...line-stages/docs/1-scan-metadata-stage.md
diff --git a/...pipeline/2-generate-website-info-stage.md → ...ges/docs/2-generate-website-info-stage.md b/...pipeline/2-generate-website-info-stage.md → ...ges/docs/2-generate-website-info-stage.md
diff --git a/.../build-pipeline/3-generate-pages-stage.md → ...ine-stages/docs/3-generate-pages-stage.md b/.../build-pipeline/3-generate-pages-stage.md → ...ine-stages/docs/3-generate-pages-stage.md
diff --git a/...y-generator/docs/build-pipeline/README.md → packages/pipeline-stages/docs/README.md b/...y-generator/docs/build-pipeline/README.md → packages/pipeline-stages/docs/README.md
@@ -7,5 +7,3 @@ Brisk docs uses a pipeline of build stages to take the docs in a codebase and tu
 - [Scan metadata stage](./1-scan-metadata-stage.md)
 - [Generate website info stage](./2-generate-website-info-stage.md)
 - [Generate pages stage](./3-generate-pages-stage.md)
-- [Build website stage](./4-build-website-stage.md)
-- [Start website stage](./5-start-website-stage.md)
diff --git a/packages/pipeline-stages/package.json b/packages/pipeline-stages/package.json
@@ -0,0 +1,27 @@
+{
+  "name": "@brisk-docs/pipeline-stages",
+  "version": "0.1.0",
+  "main": "dist/pipeline-stages.cjs.js",
+  "files": [
+    "default-pages",
+    "dist"
+  ],
+  "dependencies": {
+    "@babel/runtime": "^7.4.3",
+    "filenamify": "^4.0.0",
+    "fs-extra": "^7.0.1",
+    "glob": "^7.1.3",
+    "js-yaml": "^3.13.1",
+    "lodash.flatten": "^4.4.0",
+    "outdent": "^0.7.0",
+    "pkg-dir": "^4.2.0",
+    "remark-frontmatter": "^1.3.2",
+    "remark-parse": "^6.0.3",
+    "title-case": "^2.1.1",
+    "unified": "^7.1.0"
+  },
+  "peerDependencies": {},
+  "devDependencies": {
+    "jest-fixtures": "^0.6.0"
+  }
+}
diff --git a/...ne/stages/common/configuration-options.ts → ...tages/src/common/configuration-options.ts b/...ne/stages/common/configuration-options.ts → ...tages/src/common/configuration-options.ts
@@ -1,4 +1,4 @@
-import { TemplateSpecifier } from '../../../../types';
+import { TemplateSpecifier } from '../types';
 
 export interface ProjectDocsConfig {
   // absolute path to the docs in the filesystem

diff --git a/.../src/pipeline/stages/common/page-specs.ts → .../pipeline-stages/src/common/page-specs.ts b/.../src/pipeline/stages/common/page-specs.ts → .../pipeline-stages/src/common/page-specs.ts
diff --git a/...rc/pipeline/stages/common/project-info.ts → ...ipeline-stages/src/common/project-info.ts b/...rc/pipeline/stages/common/project-info.ts → ...ipeline-stages/src/common/project-info.ts
diff --git a/...s__/page-writers.integration.test.js.snap → ...s__/page-writers.integration.test.js.snap b/...s__/page-writers.integration.test.js.snap → ...s__/page-writers.integration.test.js.snap
diff --git a/packages/pipeline-stages/src/generate-pages/get-default-pages-path.ts b/packages/pipeline-stages/src/generate-pages/get-default-pages-path.ts
@@ -0,0 +1,10 @@
+import path from 'path';
+import pkgDir from 'pkg-dir';
+
+// Utility to get the absolute path to the default-pages directory
+export default async () => {
+  const packageRoot = await pkgDir(__dirname);
+  if (!packageRoot) throw new Error('could not resolve default-pages path');
+
+  return path.join(packageRoot, 'default-pages')
+}
diff --git a/...c/pipeline/stages/generate-pages/index.ts → ...peline-stages/src/generate-pages/index.ts b/...c/pipeline/stages/generate-pages/index.ts → ...peline-stages/src/generate-pages/index.ts
@@ -4,6 +4,7 @@ import { BriskConfiguration } from '../common/configuration-options';
 import { StageOutput as WebsiteInfoSpec } from '../generate-website-info';
 
 import * as pageWriters from './page-writers';
+import getDefaultPagesPath from './get-default-pages-path';
 
 const {
   generatePackageDocPage,
@@ -49,7 +50,8 @@ export default createStage(
   async (input: StageInput): Promise<StageOutput> => {
     const { pagesPath, wrappersPath } = input;
     await cleanPages(pagesPath);
-    await addBasePages(input.packageRoot, pagesPath);
+    const defaultPagesPath = await getDefaultPagesPath();
+    await addBasePages(defaultPagesPath, pagesPath);
 
     const generatorConfig = { pagesPath, wrappersPath };
 

diff --git a/...stages/generate-pages/integration.test.ts → ...es/src/generate-pages/integration.test.ts b/...stages/generate-pages/integration.test.ts → ...es/src/generate-pages/integration.test.ts
@@ -79,7 +79,7 @@ describe('Generate pages build stage integration', () => {
           },
         ],
       },
-      packageRoot: path.resolve(__dirname, '..', '..', '..', '..'),
+      packageRoot: path.resolve(__dirname, '..', '..'),
       sitemap: { packages: [], docs: { docs: [] } },
       readmePageData: [],
       packagesMeta: [],

diff --git a/...te-pages/page-writers.integration.test.js → ...te-pages/page-writers.integration.test.js b/...te-pages/page-writers.integration.test.js → ...te-pages/page-writers.integration.test.js
diff --git a/...ine/stages/generate-pages/page-writers.ts → ...stages/src/generate-pages/page-writers.ts b/...ine/stages/generate-pages/page-writers.ts → ...stages/src/generate-pages/page-writers.ts
@@ -10,7 +10,7 @@ import {
   singleComponentTemplate,
   wrappedComponentTemplate,
 } from './templates';
-import { TemplateSpecifier } from '../../../../types';
+import { TemplateSpecifier } from '../types';
 
 export type StageInput = {
   // Absolute path to directory containing page wrapper components
@@ -281,11 +281,10 @@ export const cleanPages = async (pagesPath: string) => {
 
 /**
  * Adds the default pages into the pages directory
- * @param packageRoot root path of packages
+ * @param defaultPagesPath absolure path to where the default pages are located
  * @param pagesPath the pages directory path
  */
-export const addBasePages = async (packageRoot: string, pagesPath: string) => {
-  const defaultPagesPath = path.join(packageRoot, 'default-pages');
+export const addBasePages = async (defaultPagesPath: string, pagesPath: string) => {
   await fs.copy(defaultPagesPath, pagesPath);
 };
 

diff --git a/...nerate-pages/templates/changelog/index.ts → ...nerate-pages/templates/changelog/index.ts b/...nerate-pages/templates/changelog/index.ts → ...nerate-pages/templates/changelog/index.ts
diff --git a/...enerate-pages/templates/changelog/test.js → ...enerate-pages/templates/changelog/test.js b/...enerate-pages/templates/changelog/test.js → ...enerate-pages/templates/changelog/test.js
diff --git a/...generate-pages/templates/example/index.ts → ...generate-pages/templates/example/index.ts b/...generate-pages/templates/example/index.ts → ...generate-pages/templates/example/index.ts
diff --git a/.../generate-pages/templates/example/test.js → .../generate-pages/templates/example/test.js b/.../generate-pages/templates/example/test.js → .../generate-pages/templates/example/test.js
diff --git a/.../stages/generate-pages/templates/index.ts → ...ges/src/generate-pages/templates/index.ts b/.../stages/generate-pages/templates/index.ts → ...ges/src/generate-pages/templates/index.ts
diff --git a/...pages/templates/single-component/index.ts → ...pages/templates/single-component/index.ts b/...pages/templates/single-component/index.ts → ...pages/templates/single-component/index.ts
diff --git a/...-pages/templates/single-component/test.js → ...-pages/templates/single-component/test.js b/...-pages/templates/single-component/test.js → ...-pages/templates/single-component/test.js
diff --git a/...es/generate-pages/templates/test-utils.js → ...rc/generate-pages/templates/test-utils.js b/...es/generate-pages/templates/test-utils.js → ...rc/generate-pages/templates/test-utils.js
diff --git a/...ages/templates/wrapped-component/index.ts → ...ages/templates/wrapped-component/index.ts b/...ages/templates/wrapped-component/index.ts → ...ages/templates/wrapped-component/index.ts
@@ -1,4 +1,4 @@
-import { TemplateSpecifier } from '../../../../../../types';
+import { TemplateSpecifier } from '../../../types';
 
 const outdent = require('outdent');
 

diff --git a/...pages/templates/wrapped-component/test.js → ...pages/templates/wrapped-component/test.js b/...pages/templates/wrapped-component/test.js → ...pages/templates/wrapped-component/test.js
diff --git a/...rc/pipeline/stages/generate-pages/test.ts → ...ipeline-stages/src/generate-pages/test.ts b/...rc/pipeline/stages/generate-pages/test.ts → ...ipeline-stages/src/generate-pages/test.ts
diff --git a/...e-website-info/__snapshots__/test.ts.snap → ...e-website-info/__snapshots__/test.ts.snap b/...e-website-info/__snapshots__/test.ts.snap → ...e-website-info/__snapshots__/test.ts.snap
diff --git a/...e-website-info/generate-docs-info.test.ts → ...e-website-info/generate-docs-info.test.ts b/...e-website-info/generate-docs-info.test.ts → ...e-website-info/generate-docs-info.test.ts
diff --git a/...nerate-website-info/generate-docs-info.ts → ...nerate-website-info/generate-docs-info.ts b/...nerate-website-info/generate-docs-info.ts → ...nerate-website-info/generate-docs-info.ts
diff --git a/...bsite-info/generate-examples-info.test.ts → ...bsite-info/generate-examples-info.test.ts b/...bsite-info/generate-examples-info.test.ts → ...bsite-info/generate-examples-info.test.ts
diff --git a/...te-website-info/generate-examples-info.ts → ...te-website-info/generate-examples-info.ts b/...te-website-info/generate-examples-info.ts → ...te-website-info/generate-examples-info.ts
diff --git a/...ebsite-info/generate-package-info.test.ts → ...ebsite-info/generate-package-info.test.ts b/...ebsite-info/generate-package-info.test.ts → ...ebsite-info/generate-package-info.test.ts
diff --git a/...ate-website-info/generate-package-info.ts → ...ate-website-info/generate-package-info.ts b/...ate-website-info/generate-package-info.ts → ...ate-website-info/generate-package-info.ts
diff --git a/...ine/stages/generate-website-info/index.ts → ...stages/src/generate-website-info/index.ts b/...ine/stages/generate-website-info/index.ts → ...stages/src/generate-website-info/index.ts
diff --git a/...ages/generate-website-info/sample-data.ts → .../src/generate-website-info/sample-data.ts b/...ages/generate-website-info/sample-data.ts → .../src/generate-website-info/sample-data.ts
diff --git a/...line/stages/generate-website-info/test.ts → ...-stages/src/generate-website-info/test.ts b/...line/stages/generate-website-info/test.ts → ...-stages/src/generate-website-info/test.ts
diff --git a/packages/pipeline-stages/src/index.ts b/packages/pipeline-stages/src/index.ts
@@ -0,0 +1,4 @@
+export { default as makePipelineStage } from './make-pipeline-stage';
+export { default as generatePagesStage } from './generate-pages';
+export { default as generateWebsiteInfoStage } from './generate-website-info';
+export { default as scanMetadataStage } from './scan-metadata';
diff --git a/...peline/stages/make-pipeline-stage.test.ts → ...ne-stages/src/make-pipeline-stage.test.ts b/...peline/stages/make-pipeline-stage.test.ts → ...ne-stages/src/make-pipeline-stage.test.ts
diff --git a/...rc/pipeline/stages/make-pipeline-stage.ts → ...ipeline-stages/src/make-pipeline-stage.ts b/...rc/pipeline/stages/make-pipeline-stage.ts → ...ipeline-stages/src/make-pipeline-stage.ts
diff --git a/...tages/scan-metadata/get-docs-info.test.ts → ...s/src/scan-metadata/get-docs-info.test.ts b/...tages/scan-metadata/get-docs-info.test.ts → ...s/src/scan-metadata/get-docs-info.test.ts
diff --git a/...ine/stages/scan-metadata/get-docs-info.ts → ...stages/src/scan-metadata/get-docs-info.ts b/...ine/stages/scan-metadata/get-docs-info.ts → ...stages/src/scan-metadata/get-docs-info.ts
diff --git a/...s/scan-metadata/get-markdown-meta.test.ts → ...c/scan-metadata/get-markdown-meta.test.ts b/...s/scan-metadata/get-markdown-meta.test.ts → ...c/scan-metadata/get-markdown-meta.test.ts
diff --git a/...stages/scan-metadata/get-markdown-meta.ts → ...es/src/scan-metadata/get-markdown-meta.ts b/...stages/scan-metadata/get-markdown-meta.ts → ...es/src/scan-metadata/get-markdown-meta.ts
diff --git a/...es/scan-metadata/get-package-info.test.ts → ...rc/scan-metadata/get-package-info.test.ts b/...es/scan-metadata/get-package-info.test.ts → ...rc/scan-metadata/get-package-info.test.ts
diff --git a/.../stages/scan-metadata/get-package-info.ts → ...ges/src/scan-metadata/get-package-info.ts b/.../stages/scan-metadata/get-package-info.ts → ...ges/src/scan-metadata/get-package-info.ts
diff --git a/...rc/pipeline/stages/scan-metadata/index.ts → ...ipeline-stages/src/scan-metadata/index.ts b/...rc/pipeline/stages/scan-metadata/index.ts → ...ipeline-stages/src/scan-metadata/index.ts
diff --git a/...src/pipeline/stages/scan-metadata/test.ts → ...pipeline-stages/src/scan-metadata/test.ts b/...src/pipeline/stages/scan-metadata/test.ts → ...pipeline-stages/src/scan-metadata/test.ts
diff --git a/packages/pipeline-stages/src/types.ts b/packages/pipeline-stages/src/types.ts
@@ -0,0 +1,72 @@
+/** This is metadata specified in the frontmatter of markdown pages */
+export type PageMeta = {
+  /** Title of the page, defaults to titlecased version of doc.id (filename) */
+  title: string;
+};
+
+export interface BasePage<T> {
+  id: string;
+  pagePath: string;
+  children?: Array<T>;
+}
+
+export interface DocsPage extends BasePage<DocsPage> {
+  meta: PageMeta;
+}
+
+export interface ExamplePage extends BasePage<ExamplePage> {
+  isolatedPath: string;
+}
+
+export interface NestedExamplePage extends ExamplePage {
+  children: ExamplePage[];
+}
+
+export type Page = DocsPage | ExamplePage | NestedExamplePage;
+
+type Maintainers = string | string[];
+
+type Repository = string | { type: string; url: string; directory?: string };
+
+type PackageMeta = {
+  id: string;
+  description: string;
+  version: string;
+  maintainers?: Maintainers;
+  repository?: Repository;
+};
+
+export declare type PackageMetadata = {
+  metaData: PackageMeta[];
+};
+
+export declare type PackageInfo = {
+  id: string;
+  description: string;
+  version: string;
+  maintainers?: Maintainers;
+  packageId: string;
+  homePath: string;
+  homeMeta: PageMeta | undefined;
+  changelogPath: string;
+  docs: DocsPage[];
+  examples: ExamplePage[];
+  subExamples: NestedExamplePage[];
+  repository: Repository;
+  parentId?: string;
+  packageTitle?: string;
+};
+
+export type pageType =
+  | 'package:changelog'
+  | 'package:doc'
+  | 'package:exampe'
+  | 'package:home'
+  | 'doc:doc';
+
+export type TemplateSpecifier = {
+  page: pageType;
+  position: 'above' | 'below' | 'replace';
+  // Path to the component from the docs config
+  component: string;
+};