Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Upsun Quick start guide #3554

Merged
merged 79 commits into from
Feb 22, 2024
Merged
Show file tree
Hide file tree
Changes from 11 commits
Commits
Show all changes
79 commits
Select commit Hold shift + click to select a range
46029aa
Quick start guide - first draft
flovntp Oct 31, 2023
b835c71
Paul's feedback on slack
flovntp Nov 3, 2023
9acecba
solving first feedback from Paul and adding navigation at the bottom …
flovntp Nov 3, 2023
c804366
adding warning when doing changes (create branch)
flovntp Nov 6, 2023
277a36b
solve gramar issue
flovntp Nov 6, 2023
65aa543
changing for default main branch (adding comments mentionning master …
flovntp Nov 6, 2023
9674eb8
uncomment Gitlab and Bitbucket links as it is still valid
flovntp Nov 8, 2023
cfcdc7b
Merge branch 'main' into fix-generic-gstarted
flovntp Jan 19, 2024
87b2040
local.
chadwcarlson Jan 23, 2024
d7865f1
WIP: singular getting started.
chadwcarlson Jan 29, 2024
0296592
small improvement
flovntp Feb 2, 2024
2c99d2f
adding Symfony guide in the get-started/stacks
flovntp Feb 5, 2024
b3ea446
merge with main
flovntp Feb 5, 2024
b6e8856
configure Node, PHP and Python draft
flovntp Feb 5, 2024
4454d38
review from Chad
flovntp Feb 5, 2024
f8297b4
General GS guide cleanup.
chadwcarlson Feb 6, 2024
0d6e279
Merge main into fix-generic-gstarted.
chadwcarlson Feb 6, 2024
5c71736
Fix shortcode build.
chadwcarlson Feb 6, 2024
1e8e11b
resolve file transfer.
chadwcarlson Feb 6, 2024
6f9aa55
Moar fixes.:
chadwcarlson Feb 6, 2024
21a08a4
merge conflicts with main
flovntp Feb 7, 2024
2a9e040
adding SFTP to accept.txt + missing vendorization
flovntp Feb 7, 2024
bf8bf4f
Merge branch 'main' into fix-generic-gstarted
chadwcarlson Feb 7, 2024
7cdbac1
Resolve some feedback.
chadwcarlson Feb 12, 2024
2cb1fca
remove local hugo file
flovntp Feb 13, 2024
983bc88
Apply suggestions from code review
flovntp Feb 13, 2024
83f968f
Apply suggestions from code review
flovntp Feb 13, 2024
cb2ac6c
Apply suggestions from code review
flovntp Feb 13, 2024
7abef2b
Apply suggestions from code review
flovntp Feb 13, 2024
11f1ab4
changing create project screenshot + lissing end of note
flovntp Feb 13, 2024
7321562
create project: adding menu with anchor
flovntp Feb 13, 2024
40d9db8
moving warning block outside of the codetab
flovntp Feb 13, 2024
dfac4a0
make-changes: adding title + note block on deploy section
flovntp Feb 13, 2024
a0d297b
adding a step for keeping the branch up-to-date
flovntp Feb 13, 2024
1cb3830
removing CLI focus mention in the requirements
flovntp Feb 13, 2024
077dcd8
merge main
flovntp Feb 13, 2024
aaa93cb
adding src/friday/_index.md in the ignore list
flovntp Feb 14, 2024
d45b28d
Merge branch 'main' into fix-generic-gstarted
flovntp Feb 14, 2024
10776ad
Merge branch 'main' into fix-generic-gstarted
flovntp Feb 14, 2024
a2131fb
remove duplicate config.yaml-baseUrl and using RelPermalink for navig…
flovntp Feb 14, 2024
acd0971
Update sites/friday/src/get-started/stacks/django.md
flovntp Feb 15, 2024
3b21e97
merge main
flovntp Feb 15, 2024
72386b3
set-resources: display issue
flovntp Feb 16, 2024
c4528b1
Friday - config.yaml: adding _index.md in the exclude list
flovntp Feb 16, 2024
b3d00b6
Gugus' reviews + adding Frameworks in the language doc page
flovntp Feb 16, 2024
f6fab62
Fix CLI shortcode.
chadwcarlson Feb 16, 2024
0f45aa6
Configure/index intro.
chadwcarlson Feb 16, 2024
36b81d2
env var note.
chadwcarlson Feb 16, 2024
8c941cd
Fix activate environment links
chadwcarlson Feb 16, 2024
291c98b
sync link.
chadwcarlson Feb 16, 2024
b814cf6
Small tweaks + image fix.
chadwcarlson Feb 16, 2024
3bca907
Default resources.
chadwcarlson Feb 16, 2024
4fcb163
resources and make-changes suggestions.
chadwcarlson Feb 16, 2024
c73e427
Move third-party out.
chadwcarlson Feb 16, 2024
0e447e9
Small tweaks
AnouckColson Feb 20, 2024
68da24e
Merge branch 'main' into fix-generic-gstarted
flovntp Feb 20, 2024
bc7367b
Delete sites/friday/http:/127.0.0.1:5001
gilzow Feb 20, 2024
e917eac
updates sentence structure
gilzow Feb 20, 2024
7c0ed14
adds link to fuller explanation of file
gilzow Feb 20, 2024
58ef2b6
Merge pull request #3792 from platformsh/gilzow-patch-2
flovntp Feb 21, 2024
cad8427
Merge branch 'main' into fix-generic-gstarted
flovntp Feb 21, 2024
d16b0ca
move end of note
flovntp Feb 21, 2024
7c7f063
remove sentence that belong to the console path
flovntp Feb 21, 2024
db975cd
adding codetab for push during change, depending on the Git path
flovntp Feb 21, 2024
4dae74a
adding codetab for push during create project, depending on the Git path
flovntp Feb 21, 2024
b883c1f
adding codetab for push during create project, depending on the Git path
flovntp Feb 21, 2024
5c291fe
adding cursor: pointer on summary
flovntp Feb 21, 2024
e150df3
split merge depending on the GIT path
flovntp Feb 21, 2024
dd5427b
if Third party inte, git push origin
flovntp Feb 21, 2024
e548025
remove upsun repo destination as it is origin
flovntp Feb 21, 2024
598f5b1
proper way to add customer css
flovntp Feb 21, 2024
fafb7cf
remove useless sentence
flovntp Feb 21, 2024
cb5cddb
move the errro on first push to configuration page
flovntp Feb 21, 2024
c521164
changing sentence for charging all activated env
flovntp Feb 21, 2024
815f790
warning on charging activ. env in the third party prov. tab
flovntp Feb 21, 2024
1354107
same sentence added for both console and cli regarding local source c…
flovntp Feb 21, 2024
f26a8f5
removing third party provider mention
flovntp Feb 22, 2024
1a745a2
missing removal of codetabs
flovntp Feb 22, 2024
2213727
Update sites/friday/src/get-started/stacks/_index.md
chadwcarlson Feb 22, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 25 additions & 12 deletions sites/friday/.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ chrome-headless:
versions:
deprecated: []
supported:
- '120'
- '113'
- '95'
- '91'
Expand Down Expand Up @@ -163,14 +164,14 @@ elixir:
type: elixir
versions:
deprecated:
- '1.13'
- '1.12'
- '1.11'
- '1.10'
- '1.9'
supported:
- '1.15'
- '1.14'
- '1.13'
- '1.12'
legacy:
- '1.10'
- '1.9'
Expand Down Expand Up @@ -260,12 +261,13 @@ java:
type: java
versions:
deprecated:
- '19'
- '18'
- '14'
- '13'
- '12'
supported:
- '21'
- '19'
- '18'
- '17'
- '11'
- '8'
Expand Down Expand Up @@ -354,15 +356,16 @@ mariadb:
deprecated:
- '10.2'
- '10.1'
- '10.3'
- '10.0'
- '5.5'
supported:
- '11.2'
- '11.0'
- '10.11'
- '10.6'
- '10.5'
- '10.4'
- '10.3'
versions-dedicated-gen-2:
supported:
- 10.8 Galera
Expand Down Expand Up @@ -451,7 +454,7 @@ memcached:
- '1.4'
versions-dedicated-gen-2:
supported:
- '1.4'
- 1.4*
mongodb:
description: Experimental MongoDB support on Platform.sh
repo_name: mongodb
Expand Down Expand Up @@ -509,7 +512,7 @@ network-storage:
disk: true
docs:
relationship_name: 'null'
service_name: files
service_name: network-storage
url: /add-services/network-storage.html
endpoint: something
min_disk_size: null
Expand Down Expand Up @@ -653,6 +656,7 @@ php:
- '7.0'
versions:
deprecated:
- '8.0'
- '7.4'
- '7.3'
- '7.2'
Expand All @@ -662,9 +666,9 @@ php:
- '5.5'
- '5.4'
supported:
- '8.3'
- '8.2'
- '8.1'
- '8.0'
postgresql:
description: PostgreSQL service for Platform.sh.
repo_name: postgresql
Expand All @@ -680,34 +684,36 @@ postgresql:
type: postgresql
versions:
deprecated:
- '11'
- '10'
- '9.6'
- '9.5'
- '9.4'
- '9.3'
supported:
- '16'
- '15'
- '14'
- '13'
- '12'
- '11'
versions-dedicated-gen-2:
deprecated:
- 11*
- 9.6*
- '9.5'
- '9.4'
- '9.3'
supported:
- 11*
supported: []
versions-dedicated-gen-3:
deprecated:
- '11'
- '10'
supported:
- '16'
- '15'
- '14'
- '13'
- '12'
- '11'
python:
description: ''
repo_name: python
Expand Down Expand Up @@ -738,6 +744,7 @@ python:
- '3.5'
- 2.7*
supported:
- '3.12'
- '3.11'
- '3.10'
- '3.9'
Expand Down Expand Up @@ -808,6 +815,7 @@ redis:
- '3.0'
- '2.8'
supported:
- '7.2'
- '7.0'
- '6.2'
legacy:
Expand All @@ -829,6 +837,7 @@ redis:
- '3.0'
- '2.8'
supported:
- '7.2'
- '7.0'
- '6.2'
ruby:
Expand Down Expand Up @@ -870,6 +879,7 @@ ruby:
- '2.4'
- '2.3'
supported:
- '3.3'
- '3.2'
- '3.1'
- '3.0'
Expand Down Expand Up @@ -969,6 +979,7 @@ varnish:
- '7.1'
- '6.0'
supported:
- '7.3'
- '7.2'
- '6.3'
vault-kms:
Expand Down Expand Up @@ -1030,6 +1041,7 @@ redis-persistent:
- '3.0'
- '2.8'
supported:
- '7.2'
- '7.0'
- '6.2'
legacy:
Expand All @@ -1051,5 +1063,6 @@ redis-persistent:
- '3.0'
- '2.8'
supported:
- '7.2'
- '7.0'
- '6.2'
4 changes: 4 additions & 0 deletions sites/friday/config/_default/params.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,10 @@ _404:
issues: "https://github.com/platformsh/platformsh-docs/issues/new"

navSections:
start:
title: Git started
section: start
weight: -130
get-started:
title: Get started
section: get-started
Expand Down
4 changes: 2 additions & 2 deletions sites/friday/src/get-started/_index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Get started
title: "[TO BE REMOVED] Get started"
aliases:
- /get-started/_index.md
---
---
2 changes: 1 addition & 1 deletion sites/friday/src/get-started/express/_index.md
Original file line number Diff line number Diff line change
@@ -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.
---

Expand Down
2 changes: 1 addition & 1 deletion sites/friday/src/get-started/nextjs/_index.md
Original file line number Diff line number Diff line change
@@ -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.
---

Expand Down
2 changes: 1 addition & 1 deletion sites/friday/src/get-started/nextjs/local.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
103 changes: 103 additions & 0 deletions sites/friday/src/get-started/quick-start/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,103 @@
---
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, or 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)
- or your other favorite stack guide?

{{% 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.

Examples:
- [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"
```

[//]: # (TODO see how to make this codetabs looks like a note section with multiple tabs)
{{< codetabs >}}
+++
title=Tips for Node.js
+++
If you're running a Node.js stack, you should also ignore adding ``node_modules`` folder (and any other unwanted folders in your Git repository) to the Git repository by using the following commands:
```bash {location="Terminal"}
echo "/node_modules" >> .gitignore
git add .gitignore && git commit -m "adding node_modules folder in .gitignore file"
```

<--->
+++
title=Tips for PHP
+++
If you're running a PHP stack with composer as dependency manager, you should also ignore adding ``vendor`` folder (and any other unwanted folders in your Git repository) to the Git repository by using the following commands:
```bash {location="Terminal"}
echo "/vendor" >> .gitignore
git add .gitignore && git commit -m "adding vendor folder in .gitignore file"
```
{{< /codetabs >}}

[//]: # (TODO rework this part as GH integration could not be part of the quickstart guide)
## 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
Loading
Loading