From d0a04ecba3b5df9770ab109e3c0c5e3f781d05e1 Mon Sep 17 00:00:00 2001 From: Nicola Molinari Date: Tue, 6 Oct 2020 19:52:39 +0200 Subject: [PATCH] docs: remove references to http-server --- .../documentation_deployment_examples.md | 2 +- .../deployment/compiling-a-custom-application.mdx | 12 +++++++++--- .../example-deployment-aws-s3-cloudfront.mdx | 5 +---- .../deployment/example-deployment-firebase.mdx | 5 +---- .../content/deployment/example-deployment-vercel.mdx | 5 +---- 5 files changed, 13 insertions(+), 16 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/documentation_deployment_examples.md b/.github/ISSUE_TEMPLATE/documentation_deployment_examples.md index 4e80926d25..8fb01b58ab 100644 --- a/.github/ISSUE_TEMPLATE/documentation_deployment_examples.md +++ b/.github/ISSUE_TEMPLATE/documentation_deployment_examples.md @@ -8,7 +8,7 @@ labels: assignees: '' --- -**Where would you like to deploy your custom application?** +**Where would you like to deploy your Custom Application?** List one of the cloud providers that you would be interested to use, that are not listed in the examples. **Additional context** diff --git a/website/src/content/deployment/compiling-a-custom-application.mdx b/website/src/content/deployment/compiling-a-custom-application.mdx index 2898125ed3..221bfb8ba9 100644 --- a/website/src/content/deployment/compiling-a-custom-application.mdx +++ b/website/src/content/deployment/compiling-a-custom-application.mdx @@ -2,9 +2,9 @@ title: Compiling a Custom Application --- -One of the necessary steps to prepare your Custom Application for a deployment is to create a [production build](/deployment/production-build). If you decide to host your Custom Application statically and do not intend to use the [provided HTTP server](/deployment/http-server), you need to compile your Custom Application. +One of the necessary steps to prepare your Custom Application for a deployment is to create a [production build](/deployment/production-build). The production build contains a `index.html.template` file that needs to be compiled into a `index.html` file to serve the Custom Application. -This section helps prepare your Custom Application for static hosting by going through the compilation step. +This section describes what compiling the Custom Application means and what are the steps to do that. # Why compile? @@ -12,7 +12,7 @@ When creating a [production build](/deployment/production-build), `mc-scripts bu One of these assets is a file named `index.html.template`. This file contains references to bundles (your code and other assets) and placeholders that needs to be replaced with values specific to your [Custom Application configuration](/development/application-config). -Therefore, compiling the application simply results in having a final `index.html` with all the correct runtime values in place. +Therefore, by compiling a Custom Application the final `index.html` file is created with all the correct runtime values in place. Once your Custom Application is compiled, it is ready for deployment. @@ -40,3 +40,9 @@ We provide some step-by-step tutorial examples for hosting a Custom Application - [Example Deployment with Vercel](/deployment/example-deployment-vercel) - [Example Deployment with Firebase](/deployment/example-deployment-firebase) - [Example Deployment with AWS, S3 and CloudFront](/deployment/example-deployment-aws-s3-cloudfront) + + + +Want to deploy to a specific cloud provider? [Let us know](https://github.com/commercetools/merchant-center-application-kit/issues/new/choose), and we can provide you with an example. + + diff --git a/website/src/content/deployment/example-deployment-aws-s3-cloudfront.mdx b/website/src/content/deployment/example-deployment-aws-s3-cloudfront.mdx index 1963dc9051..9027dbcffc 100644 --- a/website/src/content/deployment/example-deployment-aws-s3-cloudfront.mdx +++ b/website/src/content/deployment/example-deployment-aws-s3-cloudfront.mdx @@ -371,10 +371,7 @@ To make it work, we need to **compile** the application first. # Compile the application -The Merchant Center Custom Applications are available by default with a built-in [HTTP server](/deployment/http-server), which takes care of preparing the `index.html` according to the [application config](/development/application-config). - -To be able to deploy the Custom Application to AWS CloudFront, the application needs to be configured and built statically. -This is possible using the [`compile-html` command](/development/available-scripts). +To be able to deploy the Custom Application to AWS CloudFront, the Custom Application needs to be [compiled](./deployment/compiling-a-custom-application). ```console mc-scripts compile-html diff --git a/website/src/content/deployment/example-deployment-firebase.mdx b/website/src/content/deployment/example-deployment-firebase.mdx index 526debf72b..754b3a7cc9 100644 --- a/website/src/content/deployment/example-deployment-firebase.mdx +++ b/website/src/content/deployment/example-deployment-firebase.mdx @@ -136,10 +136,7 @@ To make it work, we need to **compile** the application first. # Compile the application -The Merchant Center Custom Applications are available by default with a built-in [HTTP server](/deployment/http-server), which takes care of preparing the `index.html` according to the [application config](/development/application-config). - -To be able to deploy the Custom Application to Firebase, the application needs to be configured and built statically. -This is possible using the [`compile-html` command](/development/available-scripts). +To be able to deploy the Custom Application to Firebase, the Custom Application needs to be [compiled](./deployment/compiling-a-custom-application). ```console mc-scripts compile-html diff --git a/website/src/content/deployment/example-deployment-vercel.mdx b/website/src/content/deployment/example-deployment-vercel.mdx index fda3e15cec..a7f3ef43c9 100644 --- a/website/src/content/deployment/example-deployment-vercel.mdx +++ b/website/src/content/deployment/example-deployment-vercel.mdx @@ -89,10 +89,7 @@ To make it work, we need to **compile** the application first. # Compile the application -The Merchant Center Custom Applications are available by default with a built-in [HTTP server](/deployment/http-server), which takes care of preparing the `index.html` according to the [application config](/development/application-config). - -To be able to deploy the Custom Application to the Vercel platform, the application needs to be configured and built statically. -This is possible using the [`compile-html` command](/development/available-scripts). +To be able to deploy the Custom Application to the Vercel platform, the Custom Application needs to be [compiled](./deployment/compiling-a-custom-application). ```console mc-scripts compile-html