HC docs template fixes

replicatedhq · Mar 13, 2019 · 1704d66 · 1704d66
1 parent c2e0e8f
commit 1704d66
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 15 deletions.
diff --git a/hack/docs/Makefile b/hack/docs/Makefile
@@ -42,7 +42,7 @@ markdown-assets:
 
 
 pipeline-strict: deps prebuild build gen-schema merge-mutations validate markdown-assets
-pipeline: deps prebuild build gen-schema merge-mutations 
+pipeline: deps prebuild build gen-schema merge-mutations
 
 # require validation to generate docs, pipeline only does schema
 pipeline-docs: pipeline-strict
@@ -51,17 +51,22 @@ copy-to-help-center:
 	: To copy to the Ship documentation site, run the following command:
 	:
 	:    make pipeline
-	:    cp assets/* [path/to/ship-www]/content/reference/assets/
-	:    cp lifecycle/* [path/to/ship-www]/content/reference/lifecycle/
-	:    cp config/* [path/to/ship-www]/content/reference/config/
+	:    cp assets/* [path/to/help/center]/content/api/ship-assets/
+	:    cp lifecycle/* [path/to/help/center]/content/api/ship-lifecycle/
+	:    cp config/* [path/to/help/center]/content/api/ship-config/
 
 copy-to-help-center-gopath:
-	cp assets/* $$GOPATH/src/github.com/replicatedhq/ship-www/content/reference/assets/
-	cp lifecycle/* $$GOPATH/src/github.com/replicatedhq/ship-www/content/reference/lifecycle/
-	cp config/* $$GOPATH/src/github.com/replicatedhq/ship-www/content/reference/config/
+	cp assets/* $$GOPATH/src/github.com/replicatedhq/help-center/content/api/ship-assets/
+	cp lifecycle/* $$GOPATH/src/github.com/replicatedhq/help-center/content/api/ship-lifecycle/
+	cp config/* $$GOPATH/src/github.com/replicatedhq/help-center/content/api/ship-config/
 
 copy-replicated-lint:
 	: To Copy to replicated lint, run the following command:
 	:
 	:    make pipeline
 	:    cp schema.json  [path/to/replicated-lint]/projects/replicated-ship/
+
+copy-replicated-lint-gopath:
+	cp schema.json $$GOPATH/src/github.com/replicatedhq/replicated-lint/projects/replicated-ship/
+	make -C $$GOPATH/src/github.com/replicatedhq/replicated-lint/ project-import project=replicated-ship
+
diff --git a/hack/docs/src/markdown.ts b/hack/docs/src/markdown.ts
@@ -146,7 +146,7 @@ ${yaml.safeDump({[subgroup]: {v1: [{[specType]: example}]}})}${"```"}
 function writeHeader(specTypes: any, specType, subgroup: string) {
   return `---
 categories:
-- ${subgroup}
+- ship-${subgroup}
 date: 2018-01-17T23:51:55Z
 description: ${specTypes[specType].description || ""}
 index: docs
@@ -155,7 +155,7 @@ weight: "100"
 gradient: "purpleToPink"
 ---
 
-[Assets](/reference/assets/overview) | [Config](/reference/config/overview) | [Lifecycle](/reference/lifecycle/overview)
+[Assets](/api/ship-assets/overview) | [Config](/api/ship-config/overview) | [Lifecycle](/api/ship-lifecycle/overview)
 
 ## ${specType}
 

diff --git a/hack/docs/src/static.ts b/hack/docs/src/static.ts
@@ -1,6 +1,6 @@
 export const ASSETS_INDEX_DOC = `---
 categories:
-- assets
+- ship-assets
 date: 2018-01-17T23:51:55Z
 description: Reference Documentation for defining your Ship application assets
 index: false
@@ -10,7 +10,7 @@ hideFromList: true
 gradient: "purpleToPink"
 ---
 
-[Assets](/reference/assets/overview) | [Config](/reference/config/overview) | [Lifecycle](/reference/lifecycle/overview)
+[Assets](/api/ship-assets/overview) | [Config](/api/ship-config/overview) | [Lifecycle](/api/ship-lifecycle/overview)
 
 ## Ship Assets
 
@@ -19,7 +19,7 @@ Ship Assets are files rendered during the [render](/api/ship-lifecycle/render) l
 
 export const LIFECYCLE_INDEX_DOC = `---
 categories:
-- lifecycle
+- ship-lifecycle
 date: 2018-01-17T23:51:55Z
 description: Reference Documentation for defining your Ship application lifecycle
 index: false
@@ -29,7 +29,7 @@ hideFromList: true
 gradient: "purpleToPink"
 ---
 
-[Assets](/reference/assets/overview) | [Config](/reference/config/overview) | [Lifecycle](/reference/lifecycle/overview)
+[Assets](/api/ship-assets/overview) | [Config](/api/ship-config/overview) | [Lifecycle](/api/ship-lifecycle/overview)
 
 ## Ship Lifecycle
 
@@ -39,7 +39,7 @@ Ship lifecycle steps define the steps that a Ship application will proceed throu
 
 export const CONFIG_INDEX_DOC = `---
 categories:
-- config
+- ship-config
 date: 2018-01-17T23:51:55Z
 description: Reference Documentation for defining your Ship application configuration options
 index: docs
@@ -49,7 +49,7 @@ hideFromList: true
 gradient: "purpleToPink"
 ---
 
-[Assets](/reference/assets/overview) | [Config](/reference/config/overview) | [Lifecycle](/reference/lifecycle/overview)
+[Assets](/api/ship-assets/overview) | [Config](/api/ship-config/overview) | [Lifecycle](/api/ship-lifecycle/overview)
 
 ## Ship Config