Upsun Quick start guide

sites/friday/src/get-started/express/_index.md

@@ -1,5 +1,5 @@
 ---
-title: Express
+title: (REMOVE) Express
 description:   Welcome to our quick-start guide on hosting [Express](https://expressjs.com/) on {{< vendor/name >}} where we will demonstrate just how simple it is to host your [Express](https://expressjs.com/) projects on our PaaS. Follow the steps detailed below and you’ll have everything set up in no time.
 ---
 

sites/friday/src/get-started/nextjs/_index.md

@@ -1,5 +1,5 @@
 ---
-title: Next.js
+title: (REMOVE) Next.js
 description:   Welcome to our quick-start guide on hosting [Next.js](https://nextjs.org/) on {{< vendor/name >}}, where we will demonstrate just how simple it is to host your [Next.js](https://nextjs.org/) projects on our PaaS. Follow the steps detailed below and you’ll have everything set up in no time.
 ---
 

sites/friday/src/get-started/nextjs/local.md

@@ -1,5 +1,5 @@
 ---
-title: "Local development"
+title: "(REMOVE) Local development"
 weight: -120
 description: |
   Once Your Next.js application has been deployed on {{% vendor/name %}}, you might want to start developing your application locally.

sites/friday/src/get-started/quick-start/_index.md

@@ -0,0 +1,89 @@
+---
+title: Quick Start
+weight: -100
+description:   Welcome to our quick-start guide on hosting any stacks on {{< vendor/name >}} where we will demonstrate just how simple it is to host your projects on our PaaS. Follow the steps detailed below and you’ll have everything set up in no time.
+---
+
+{{% description %}}
+
+If you're trying to host a Django, a Laravel, nor a Flask stack, please follow corresponding guide:
+
+- [Django Getting started guide](../django/_index.md)
+- [Laravel Getting started guide](../laravel/_index.md)
+- [Flask Getting started guide](../flask/_index.md)
+
+{{% guides/link-philosophy %}}
+
+{{< note title=”Tip” >}}
+To get your project up and running as quickly as possible, experiment with the [{{% vendor/name %}} demo app](https://console.upsun.com/projects/create-project/demo) before following this guide.
+{{< /note >}}
+
+{{% guides/requirements name="Stacks" %}}
+
+## Create your local app
+
+First things first, if you don’t have a local project, you need one. So please create your project locally by following the official guide of your choice.
+
+Example:
+- [Express installation guide](https://expressjs.com/en/starter/installing.html)
+- [Next.js installation guide](https://nextjs.org/docs/getting-started/installation)
+- [Strapi installation guide](https://docs.strapi.io/dev-docs/installation)
+
+
+## Initialize your Git repository
+
+We need to initialize the local Git repository and commit local files, using the following command:
+
+```bash {location="Terminal"}
+git init
+git add .
+git commit -m "Init my application"
+```
+
+{{< note title="Tips" >}}
+
+Depending on your stack, you should also ignore adding ``node_modules`` folder (or any other unwanted folders in your Git repository) to the Git repository by using the following commands to do so:
+
+```bash {location="Terminal"}
+echo "/node_modules" >> .gitignore
+git add .gitignore && git commit -m "adding node_modules folder in .gitignore file"
+```
+{{< /note >}}
+
+## Choose your Git workflow
+
+{{% vendor/name %}} projects can be used as a classic Git repository where you will be able to push your source code in different ways, using either the Git CLI or the {{% vendor/name %}} CLI. You can choose which way—or Git workflow— you would like to use for your project from the following options:
+
+- Your project source code will be **hosted on a {{% vendor/name %}} Git repository**
+- Your project source code will be **hosted on your own GitHub repository**
+
+{{< codetabs >}}
++++
+title={{% vendor/name %}} Git repository
++++
+For the rest of this guide, you will use the normal Git workflow (`git add . && git commit -m "message" && git push {{% vendor/cli %}}`) to commit your source code changes to Git history, and use the {{% vendor/name %}} CLI to deploy your [{{% vendor/name %}} environment](/environments.html) with the latest code updates.
+
+<--->
++++
+title=GitHub repository
++++
+{{% vendor/name %}} provides a feature called [Github integration](integrations/source/github.md) that allows your {{% vendor/name %}} project to be fully integrated with your Github repository.
+This enables you, as a developer, to use a normal Git workflow (`git add . && git commit -m "message" && git push`) to deploy your environment—with no need to connect to the {{% vendor/name %}} Console.
+
+{{< note >}}
+Please make sure you that you have already completed the following steps before adding a [Github integration](integrations/source/github.md):
+
+1. Create a Git repository in your own organization following the relevant [Github repository creation guide](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-new-repository).
+2. Create a [Github integration](integrations/source/github.md).
+3. Add a Git remote to your local project, from the root of your project, by inputting the following:
+
+    ```bash {location="Terminal"}
+    git remote add origin <urlOfYourOwnGitHubRepo>
+    git add . && git commit -m "init my app"
+    git push origin
+    ```
+{{< /note >}}
+
+{{< /codetabs >}}
+
+## Next steps

sites/friday/src/get-started/quick-start/configure.md

@@ -0,0 +1,135 @@
+---
+title: Configure your project
+weight: 20
+description: Configure your project
+---
+
+## Configure your project
+
+To be able to host your application on {{% vendor/name %}}, some YAML configuration files are needed at the root of your project to manage the way your application will behave.
+These YAML configuration files are located into a `.{{% vendor/cli %}}/` folder at the root of your source code, the architecture of which will look like this:
+```
+my-app
+├── .{{% vendor/cli %}}
+│   └── config.yaml
+├── [.environment]
+└── <project sources>
+```
+
+{{< note >}}
+{{% get-started/environment-note %}}
+{{< /note >}}
+
+To pre-generate these YAML files, please use the following command from the root of your project and follow the prompts:
+```bash {location="Terminal"}
+{{% vendor/cli %}} project:init
+```
+
+The `{{% vendor/cli %}} project:init` command (shortcut `{{% vendor/cli %}} ify`) will automatically detect which stack that you’re using, ask if you want to add any services, and generate the corresponding `config.yaml` YAML files, like so:
+```yaml {location=".{{% vendor/cli %}}/config.yaml"}
+{{< code-link destination="/create-apps/app-reference.html" text="applications" title="Complete list of all available properties" >}}:
+  app:
+    {{< code-link destination="/create-apps/app-reference.html#source" text="source" title="Application source code directory. Click for more information" >}}:
+      root: "/"
+    {{< code-link destination="/create-apps/app-reference.html#types" text="type" title="The runtime the application uses. Click to see the complete list of available runtimes." >}}: "<runtime>:<version>"
+    {{< code-link destination="/create-apps/app-reference.html#types" text="web" title="The web key configures the web server running in front of your app. Click for more information." >}}:
+      {{< code-link destination="/create-apps/app-reference.html#web-commands" text="commands" title="Commands are run once after deployment to start the application process. Click for more information." >}}:
+        {{< code-link destination="/languages/nodejs.html#4-start-your-app" text="start" title="The command to launch your app. If it terminates, it’s restarted immediately. You can use the $PORT or the $SOCKET environment variable depending on the socket family of your upstream. Click for more information." >}}: "// (optional) command to start Node server"
+    {{< code-link destination="/create-apps/app-reference.html#build" text="build" title="Specifies a default set of build tasks to run. Flavors are language-specific. Click for more information" >}}:
+      flavor: none
+    {{< code-link destination="/create-apps/app-reference.html#web-commands" text="dependencies" title="Installs global dependencies as part of the build process. They’re independent of your app’s dependencies and are available in the PATH during the build process and in the runtime environment. They’re installed before the build hook runs using a package manager for the language. Click for more information." >}}:
+      # nodejs:
+        # sharp: "*"
+#{{< code-link destination="/add-services.html#available-services" text="services" title="Click to get Full list of available services." >}}:
+#  db:
+#    type: postgresql:14
+{{< code-link destination="/define-routes.html" text="routes" title="Each route describes how an incoming URL is going to be processed. Click for more information" >}}:
+  "https://{default}/":
+    type: upstream
+    upstream: "app:http"
+  # A basic redirect definition
+  # More information: {{% vendor/url_doc %}}/define-routes.html#basic-redirect-definition
+  "https://www.{default}/":
+    type: redirect
+    to: "https://{default}/"
+```
+
+[//]: # ({{< note >}})
+[//]: # (In the current guide, services are added to your project at a [later stage]&#40;/get-started/express/add-database.md&#41;.)
+[//]: # ({{< /note >}})
+
+Then commit your new files, using the following command:
+
+```bash {location="Terminal"}
+git add [.environment] .{{% vendor/cli %}}/config.yaml
+git commit -m "{{% vendor/name %}} config files"
+```
+
+[//]: # (TODO not sure that .environment would be generated each time we use project:init)
+{{< note >}}
+Depending on your choice during the ``{{% vendor/cli %}} project:init`` command to add or not a service, ``.environment`` file could be missing from your source code, so please remove it from the previous `git add` command if that's the case.
+{{< /note >}}
+
+## Set your project remote
+
+{{< note >}}
+If you used the {{% vendor/name %}} CLI command `{{% vendor/cli %}} project:create` to create your project and your local Git repository has already been initialized, your local source code should already contain a ``.{{% vendor/cli %}}/local/project.yaml`` file. This file contains your `projectId`, and you already have a Git remote repository set to `{{% vendor/cli %}}`.
+You can jump to [deploying your project](#deploy).
+{{< /note >}}
+
+There are slightly different ways to link your local project to your {{% vendor/name %}} project based on the Git workflow you chose for your project, as discussed earlier in this guide.
+
+{{< codetabs >}}
++++
+title={{% vendor/name %}} Git repository
++++
+If you host your source code on an {{% vendor/name %}} Git repository, and you failed to answer `y` (yes) to the question `Set the new project <projectName> as the remote for this repository? [Y/n]` during the ``project:create`` command, you need to let the {{% vendor/name %}} CLI know which linked project you want to deploy to.
+
+To do so, use the {{% vendor/name %}} CLI to set a remote project:
+```bash {location="Terminal"}
+{{% vendor/cli %}} project:set-remote <projectId>
+```
+
+This command will add a new remote called `{{% vendor/cli %}}` to your local Git repo as you can see below:
+```bash {location="Terminal"}
+git remote
+{{% vendor/cli %}}
+...
+```
+
+It will also create a new `.{{% vendor/cli %}}/local/project.yaml` file that will contain the given `<projectId>`, to store this information for the {{% vendor/name %}} CLI interaction.
+
+{{< note >}}
+If you don’t remember your `<projectId>` from the previous steps, you can get it back using this command line and select the one you created:
+```bash {location="Terminal"}
+{{% vendor/cli %}} project:list
+```
+{{< /note >}}
+
+<--->
++++
+title=GitHub repository
++++
+{{% guides/whitelabel/git_integration git="GitHub" stack="" %}}
+<--->
+
+[//]: # (TODO uncomment this tab when Gitlab or Bitbucket integration would be available)
+[//]: # (+++)
+
+[//]: # (title=Gitlab repository)
+
+[//]: # (+++)
+
+[//]: # ({{% guides/whitelabel/git_integration git="Gitlab" stack="Express" %}})
+
+[//]: # (<--->)
+
+[//]: # (+++)
+
+[//]: # (title=Bitbucket repository)
+
+[//]: # (+++)
+
+[//]: # ({{% guides/whitelabel/git_integration git="Bitbucket" stack="Express" %}})
+
+{{< /codetabs >}}

sites/friday/src/get-started/quick-start/create-project.md

@@ -0,0 +1,68 @@
+---
+title: Create a new project
+weight: 10
+description: Configure your project
+---
+
+To create a new project on {{% vendor/name %}}, you can either use the {{% vendor/name %}} CLI or the {{% vendor/name %}} Console.
+
+{{< codetabs >}}
++++
+title=Using the CLI
++++
+To create a new project with the {{% vendor/name %}} CLI, use the following command and follow the prompt:
+```bash {location="Terminal"}
+{{% vendor/cli %}} project:create
+```
+
+{{< note >}}
+When creating a new project using the {{% vendor/name %}} CLI command `project:create`, you will be asked if you want to set the local remote to your new project. Enter **Yes (y)**.
+
+Your local source code will be automatically linked to your newly created {{% vendor/name %}} project by creating a `.{{% vendor/cli %}}/local/project.yaml` file that will contain the corresponding `<projectId>` and set a Git remote to `{{% vendor/cli %}}`.
+
+```bash {location="Terminal"}
+git remote
+{{% vendor/cli %}}
+```
+
+If not, please refer to [Set project remote](#set-project-remote) section.
+{{< /note >}}
+
+<--->
++++
+title=Using the Console
++++
+
+[Create a new project from scratch]({{% create-project-link scratch=true %}}).
+
+If you do not already have an organization created to put the project in, you'll first be instructed to create one.
+
+Once you have done so, select that organization from the dropdown, and select **Create from scratch**.
+
+In the form, fill in details like the project name and [region](/development/regions.md).
+You'll be able to define resources for the project after your first push.
+
+After creating a project with the Console, you need to let the {{% vendor/name %}} CLI know which linked project you want to deploy to.
+
+To do so, use the {{% vendor/name %}} CLI to set a remote project:
+```bash {location="Terminal"}
+{{% vendor/cli %}} project:set-remote <projectId>
+```
+
+This command will add a new remote called `{{% vendor/cli %}}` to your local Git repo as you can see below:
+```bash {location="Terminal"}
+git remote
+origin
+{{% vendor/cli %}}
+```
+
+It will also create a new `.{{% vendor/cli %}}/local/project.yaml` file that will contain the given `<projectId>`, to store this information for the {{% vendor/name %}} CLI interaction.
+
+{{< note >}}
+If you don’t remember your `<projectId>` from the previous steps, you can get it back using this command line and select the one you created:
+```bash {location="Terminal"}
+{{% vendor/cli %}} project:list
+```
+{{< /note >}}
+
+{{< /codetabs >}}

sites/friday/src/get-started/quick-start/deploy.md

@@ -0,0 +1,50 @@
+---
+title: Deploy
+weight: 30
+description:   Welcome to our quick-start guide on hosting any stacks on {{< vendor/name >}} where we will demonstrate just how simple it is to host your projects on our PaaS. Follow the steps detailed below and you’ll have everything set up in no time.
+---
+
+## Deploy
+
+And just like that, it’s time to deploy!
+
+Depending on the Git workflow you choose at the beginning of this tutorial, there are two ways to deploy your source code changes.
+
+{{< codetabs >}}
+
++++
+title=Using {{% vendor/name %}} Git repository
++++
+
+When using the {{% vendor/name %}} Git repository as your main repository, you can push your code using the normal Git workflow (`git add . && git commit -m "message" && git push {{% vendor/cli %}}`). This pushes your source code changes to your `{{% vendor/cli %}}` remote repository. Alternatively, you can use the following {{% vendor/name %}} CLI command:
+```bash {location="Terminal"}
+{{% vendor/cli %}} push
+```
+
+<--->
++++
+title=Using third-party Git repository
++++
+
+When using an external Git repository (GitHub, GitLab, or Bitbucket) to store your source code and having the Git integration feature enabled, on each code updates, you will need to use the normal Git workflow (`git add . && git commit -m "message" && git push`) to push your code to your external repository. To do so, run the following command:
+```bash {location="Terminal"}
+git push origin
+```
+
+Your GitHub/GitLab/Bibucket integration process will then automatically create a new environment if you’re pushing a new Git branch, and deploy changes to your corresponding environment.
+{{< /codetabs >}}
+
+{{% vendor/name %}} will now read your configuration files, and begin building your application image.
+
+{{< note >}}
+By default, {{% vendor/name %}} will use the default resource allocation for each of your services/apps. To change allocated resources to each of your services/apps, please see [how to set resources to your project](./set-resources.md) section
+{{< /note >}}
+
+Et voilà, your application is live!
+
+
+[//]: # (**Your first push)
+
+[//]: # (will fail**; don't worry, this is expected. At this point {{% vendor/cli %}} is not aware of the resources)
+
+[//]: # (your application needs. You need to define how much CPU, memory, and disk to assign to the various containers. Back in your terminal, run:)

sites/friday/src/get-started/quick-start/local/_index.md

@@ -0,0 +1,19 @@
+---
+title: Local development
+weight: 70
+description: |
+    Sync {{% vendor/name %}} with your local environments to start contributing.
+---
+
+A significant amount of work developing your app takes place locally rather than on an active {{% vendor/name %}} environment.
+You want to ensure that the process of local development is as close as possible to a deployed environment.
+
+You can achieve this through various approaches.
+Each of these examples:
+
+- Creates a local development environment for your site.
+- Syncs data from the active {{% vendor/name %}} environment where team review takes place.
+- Commits aspects of that local development method to the project so collaborators can replicate configuration to contribute.
+
+[//]: # (If you're already using Docker Compose,)
+[//]: # (consult the Community guide on [using Docker Compose with Django and {{% vendor/name %}}](https://community.platform.sh/t/using-docker-compose-with-django/1205).)