feat(docs): Re-organize & update documentation for plugins

vendure-ecommerce · Mar 13, 2020 · 8f3c979 · 8f3c979
1 parent 9a078cf
commit 8f3c979
Show file tree

Hide file tree

Showing 25 changed files with 755 additions and 578 deletions.
diff --git a/docs/content/docs/developer-guide/deployment.md b/docs/content/docs/developer-guide/deployment.md
@@ -15,3 +15,7 @@ The bare minimum requirements are:
 A typical pattern is to run the Vendure app on the server, e.g. at `http://localhost:3000` an then use [nginx as a reverse proxy](https://docs.nginx.com/nginx/admin-guide/web-server/reverse-proxy/) to direct requests from the Internet to the Vendure application.
 
 Here is a good guide to setting up a production-ready server for an app such as Vendure: https://www.digitalocean.com/community/tutorials/how-to-set-up-a-node-js-application-for-production-on-ubuntu-18-04
+
+## Admin UI
+
+If you have customized the Admin UI with extensions, it can make sense to [compile your extensions ahead-of-time as part of the deployment process]({{< relref "/docs/plugins/extending-the-admin-ui" >}}#compiling-as-a-deployment-step).
diff --git a/docs/content/docs/developer-guide/order-workflow/_index.md b/docs/content/docs/developer-guide/order-workflow/_index.md
@@ -25,5 +25,5 @@ So if the customer adds 2 *Widgets* to the Order, there will be **one OrderLine*
 
 ## Shop client order workflow
 
-The [GraphQL API Guide]({{< relref "/docs/developer-guide/graphql-api-guide" >}}#order-flow) lists the GraphQL operations you will need to implement this workflow in your storefront client application.
+The [GraphQL Shop API Guide]({{< relref "/docs/storefront/shop-api-guide" >}}#order-flow) lists the GraphQL operations you will need to implement this workflow in your storefront client application.
 
diff --git a/docs/content/docs/developer-guide/overview/_index.md b/docs/content/docs/developer-guide/overview/_index.md
@@ -36,4 +36,4 @@ Vendure supports multiple databases. Currently it is tested with MySQL/MariaDB,
 
 ## Custom Business Logic (Plugins)
 
-Not shown on the diagram (for the sake of simplicity) are plugins. Plugins are the mechanism by which you extend Vendure with your own business logic and functionality. See [the Plugins docs]({{< relref "/docs/developer-guide/plugins" >}})
+Not shown on the diagram (for the sake of simplicity) are plugins. Plugins are the mechanism by which you extend Vendure with your own business logic and functionality. See [the Plugins docs]({{< relref "/docs/plugins" >}})
diff --git a/docs/content/docs/developer-guide/plugins/_index.md b/docs/content/docs/developer-guide/plugins/_index.md
Original file line number	Diff line number	Diff line change
Expand Up		@@ -25,5 +25,5 @@ So if the customer adds 2 Widgets to the Order, there will be *one OrderLine

		## Shop client order workflow

		The [GraphQL API Guide]({{< relref "/docs/developer-guide/graphql-api-guide" >}}#order-flow) lists the GraphQL operations you will need to implement this workflow in your storefront client application.
		The [GraphQL Shop API Guide]({{< relref "/docs/storefront/shop-api-guide" >}}#order-flow) lists the GraphQL operations you will need to implement this workflow in your storefront client application.
Original file line number	Diff line number	Diff line change
Expand Up		@@ -36,4 +36,4 @@ Vendure supports multiple databases. Currently it is tested with MySQL/MariaDB,

		## Custom Business Logic (Plugins)

		Not shown on the diagram (for the sake of simplicity) are plugins. Plugins are the mechanism by which you extend Vendure with your own business logic and functionality. See [the Plugins docs]({{< relref "/docs/developer-guide/plugins" >}})
		Not shown on the diagram (for the sake of simplicity) are plugins. Plugins are the mechanism by which you extend Vendure with your own business logic and functionality. See [the Plugins docs]({{< relref "/docs/plugins" >}})