diff --git a/web/docs/deployment/ci-cd.md b/web/docs/deployment/ci-cd.md new file mode 100644 index 0000000000..af679f990f --- /dev/null +++ b/web/docs/deployment/ci-cd.md @@ -0,0 +1,7 @@ +--- +title: CI/CD Scenarios +--- + +TODO: we'll talk about how to e2e test Wasp apps in the CI + +TODO: we'll talk about building the server as a Docker image in the CI \ No newline at end of file diff --git a/web/docs/deployment/database.md b/web/docs/deployment/database.md new file mode 100644 index 0000000000..37fe8c27d7 --- /dev/null +++ b/web/docs/deployment/database.md @@ -0,0 +1,11 @@ +--- +title: Database +--- + +TODO: we'll explain the database in the context of deployment + +TODO: the only requirement from Wasp's point of view - it has to be a PostgreSQL database accessible from the server via the `DATABASE_URL` environment variable + +TODO: we'll talk about migrations: how are they created in development, how are they applied in production, how to debug failed migrations + +TODO: we'll talk about how to open the DB studio in development and production \ No newline at end of file diff --git a/web/docs/advanced/deployment/DeploymentOptionsGrid.css b/web/docs/deployment/deployment-methods/DeploymentOptionsGrid.css similarity index 100% rename from web/docs/advanced/deployment/DeploymentOptionsGrid.css rename to web/docs/deployment/deployment-methods/DeploymentOptionsGrid.css diff --git a/web/docs/advanced/deployment/DeploymentOptionsGrid.tsx b/web/docs/deployment/deployment-methods/DeploymentOptionsGrid.tsx similarity index 100% rename from web/docs/advanced/deployment/DeploymentOptionsGrid.tsx rename to web/docs/deployment/deployment-methods/DeploymentOptionsGrid.tsx diff --git a/web/docs/advanced/deployment/_addExternalAuthEnvVarsReminder.md b/web/docs/deployment/deployment-methods/_addExternalAuthEnvVarsReminder.md similarity index 100% rename from web/docs/advanced/deployment/_addExternalAuthEnvVarsReminder.md rename to web/docs/deployment/deployment-methods/_addExternalAuthEnvVarsReminder.md diff --git a/web/docs/advanced/deployment/_building-the-web-client.md b/web/docs/deployment/deployment-methods/_building-the-web-client.md similarity index 100% rename from web/docs/advanced/deployment/_building-the-web-client.md rename to web/docs/deployment/deployment-methods/_building-the-web-client.md diff --git a/web/docs/advanced/deployment/cli.md b/web/docs/deployment/deployment-methods/cli.md similarity index 99% rename from web/docs/advanced/deployment/cli.md rename to web/docs/deployment/deployment-methods/cli.md index 42b028b03c..be07320402 100644 --- a/web/docs/advanced/deployment/cli.md +++ b/web/docs/deployment/deployment-methods/cli.md @@ -1,5 +1,5 @@ --- -title: Deploying with the Wasp CLI +title: Wasp CLI --- import { Required } from '@site/src/components/Tag'; diff --git a/web/docs/advanced/deployment/overview.md b/web/docs/deployment/deployment-methods/overview.md similarity index 100% rename from web/docs/advanced/deployment/overview.md rename to web/docs/deployment/deployment-methods/overview.md diff --git a/web/docs/advanced/deployment/manually.md b/web/docs/deployment/deployment-methods/paas.md similarity index 99% rename from web/docs/advanced/deployment/manually.md rename to web/docs/deployment/deployment-methods/paas.md index 29c480b1e8..575fa5c2f7 100644 --- a/web/docs/advanced/deployment/manually.md +++ b/web/docs/deployment/deployment-methods/paas.md @@ -1,5 +1,5 @@ --- -title: Deploying Manually +title: Platform as a Service (PaaS) --- import useBaseUrl from '@docusaurus/useBaseUrl'; diff --git a/web/docs/deployment/deployment-methods/self-hosted.md b/web/docs/deployment/deployment-methods/self-hosted.md new file mode 100644 index 0000000000..fd0b3ae1c6 --- /dev/null +++ b/web/docs/deployment/deployment-methods/self-hosted.md @@ -0,0 +1,6 @@ +--- +title: Self-Hosted +--- + +TODO: Talk about how to setup Wasp with a plain VPS, Caprover and Coolify + diff --git a/web/docs/deployment/env-vars.md b/web/docs/deployment/env-vars.md new file mode 100644 index 0000000000..da667eebfc --- /dev/null +++ b/web/docs/deployment/env-vars.md @@ -0,0 +1,7 @@ +--- +title: Environment Variables +--- + +TODO: we'll explain env vars in the deployment context - client vs. server env vars, all the required env vars, development vs. production env vars + +TODO: deduplicate with the env vars section in the project setup category \ No newline at end of file diff --git a/web/docs/deployment/extras.md b/web/docs/deployment/extras.md new file mode 100644 index 0000000000..23270fae1a --- /dev/null +++ b/web/docs/deployment/extras.md @@ -0,0 +1,9 @@ +--- +title: Extras +--- + +TODO: Is Wasp production ready? What are the limitations? + +TODO: DDos and CDN recommendations + +TODO: Custom domain setup \ No newline at end of file diff --git a/web/docs/deployment/intro.md b/web/docs/deployment/intro.md new file mode 100644 index 0000000000..1feb27d670 --- /dev/null +++ b/web/docs/deployment/intro.md @@ -0,0 +1,10 @@ +--- +title: Introduction +--- + +TODO: the time to share your app with the world has come + +TODO: we'll take you through the process of deploying your app to the web + +TODO: first, you'll need to understand the structure of a Wasp app: Node.js backend, React frontend, and a PostgreSQL database. We'll explain the client app, server app and how it connects to the database. + diff --git a/web/sidebars.js b/web/sidebars.js index 2a6571d0b3..2f3a971c0d 100644 --- a/web/sidebars.js +++ b/web/sidebars.js @@ -97,6 +97,30 @@ module.exports = { 'project/custom-vite-config', ], }, + { + type: 'category', + label: 'Deployment', + collapsed: false, + collapsible: true, + items: [ + 'deployment/intro', + 'deployment/env-vars', + 'deployment/database', + { + type: 'category', + label: 'Deployment Methods', + collapsed: true, + items: [ + 'deployment/deployment-methods/overview', + 'deployment/deployment-methods/cli', + 'deployment/deployment-methods/paas', + 'deployment/deployment-methods/self-hosted', + ], + }, + 'deployment/ci-cd', + 'deployment/extras', + ], + }, { type: 'category', label: 'Wasp AI', @@ -119,17 +143,6 @@ module.exports = { 'advanced/links', ], }, - { - type: 'category', - label: 'Deployment', - collapsed: false, - collapsible: true, - items: [ - 'advanced/deployment/overview', - 'advanced/deployment/cli', - 'advanced/deployment/manually', - ], - }, { type: 'category', label: 'General', @@ -139,7 +152,7 @@ module.exports = { 'general/language', 'general/cli', 'general/typescript', - 'general/wasp-ts-config' + 'general/wasp-ts-config', ], }, {