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 56 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
1,055 changes: 0 additions & 1,055 deletions sites/friday/.yaml

This file was deleted.

3 changes: 2 additions & 1 deletion sites/friday/config/_default/config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ languages:

disableKinds: ["taxonomy", "taxonomyTerm"]

baseURL: "https://docs.upsun.com"
#baseURL: "https://docs.upsun.com"

summaryLength: 3

Expand Down Expand Up @@ -53,6 +53,7 @@ module:
- source: "../platform/src"
target: "content"
excludeFiles:
- "_index.md"

- "add-services/*"
# - "add-services/network-storage.md"
Expand Down
Empty file.
65 changes: 65 additions & 0 deletions sites/friday/layouts/shortcodes/community-buttons.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
<div style="margin-top: 3rem; text-align: center;">
<a class="start-cta font-semibold text-sm xl:text-base px-4 py-2 bg-skye rounded text-white hover:bg-skye-dark focus:bg-skye-dark"
href="https://discord.gg/PkMc2pVCDV" rel="noopener">Join us on Discord</a>
<a class="info-cta font-semibold text-sm xl:text-base px-4 py-2 bg-skye rounded text-white hover:bg-skye-dark focus:bg-skye-dark"
href="https://support.platform.sh/hc/en-us/community/topics" rel="noopener">Ask a question on the forum</a>
</div>

<style>
.home-resources {
text-align: center;
padding: 1rem 2rem;
border: 2px solid #191C1E;
border-color: #191C1E !important;
}

.tg-0lax {
text-align: center;
background-color: white !important;
}

.resource-list {
list-style: none;
padding-left: 0rem !important;
}

.start-cta {
color: white !important;
/* color: #191C1E !important; */
text-decoration: none !important;
font-size: 16px !important;
font-weight: 700 !important;
letter-spacing: 0.48px !important;
background: #6046FF !important;
/* background: #FFBDBB!important; */
padding: 10px 16px !important;
margin-right: 1rem;
border-radius: 0px !important;
border-radius: 80px !important;
}
.start-cta:hover {
background: #4D38CC !important;
/* background: #FF9F9F !important; */
/* color: #191C1E !important; */
color: white !important;
}

.info-cta {
color: #191C1E !important;
text-decoration: none !important;
font-size: 16px !important;
font-weight: 700 !important;
letter-spacing: 0.48px !important;
background: white !important;
padding: 10px 16px !important;
border-radius: 80px !important;
/* border-radius: 0px !important; */
border: 2px solid #191C1E;
border-color: #191C1E !important;
}
.info-cta:hover {
background: #191C1E !important;
color: white !important;
}

</style>
2 changes: 1 addition & 1 deletion sites/friday/layouts/shortcodes/home.html
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ <h1>{{ .Site.Title }}</h1>

<div style="margin-top: 3rem;">
<a class="start-cta font-semibold text-sm xl:text-base px-4 py-2 bg-skye rounded text-white hover:bg-skye-dark focus:bg-skye-dark"
href="/get-started.html" rel="noopener">Get started</a>
href="/get-started/here.html" rel="noopener">Get started</a>
<a class="info-cta font-semibold text-sm xl:text-base px-4 py-2 bg-skye rounded text-white hover:bg-skye-dark focus:bg-skye-dark"
href="/learn/overview.html" rel="noopener">What is {{ .Site.Params.vendor.name }}?</a>
</div>
Expand Down
93 changes: 93 additions & 0 deletions sites/friday/src/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
---
title: Introduction
showTitle: false
editPage: false
feedback: false
---

{{< home >}}

## How the docs are organized

There are different [kinds](https://documentation.divio.com/) of documentation.
Some docs are useful when you're just starting out,
while others go into detail that's relevant only after you've deployed many projects on {{% vendor/name %}}.

This site is roughly split into categories based on where you are in your journey working with {{% vendor/name %}}, described below.

### Get started

If you're still unfamiliar with {{% vendor/name %}} and how it works, _but_ you're also looking to quickly start working with the platform, the **Get started** section is the right place to begin.

Learn the basics of how {{% vendor/name %}} leverages Git to produce reusable build images, identical-to-production environments in staging and development (including production data), as well as the basics of monitoring and troubleshooting your environments.

Ready to get started? [Let's go!](/get-started/here)

### Learn

After going through the **Get started** section, you may want to know more about how {{% vendor/name %}} works and the logic behind it. The **[Learn](/learn/_index.md)** section is a collection of tutorials and conceptual guides to help you understand the ins and outs of {{% vendor/name %}}.

- [**What is {{% vendor/name %}}?**](/learn/overview/_index.md)

With this guide, find out which problem {{% vendor/name %}} is trying to solve.
Learn how {{% vendor/name %}}'s configuration, build and deploy pipelines, and the structure of environments play into the broader philosophy behind reliably deploying applications.

- [**Tutorials**](/learn/tutorials/_index.md)

Once you're familiar with {{% vendor/name %}}, its basic rules and philosophy, you may be curious about how you can replicate common workflows in other tools on our platform.
From scheduling dependency updates and backups to exporting data, the [**Tutorials**](/learn/tutorials/_index.md) provide all the information you need.

- [**Best practices**](/learn/bestpractices/_index.md)

{{% vendor/name %}} makes deploying and managing infrastructure no different than working with Git.
As your work becomes more experimental, however, you may be interested in optimizing your workflows, and addressing common constraints of the platform.
The [**Best practices**](/learn/bestpractices/_index.md) documentation contains articles that address advanced use cases for caching, microservices, and more.

### Frameworks

Now that you understand the basic rules of {{% vendor/name %}}, you're likely ready to deploy your own custom code in a chosen framework.
The **Frameworks** section is a collection of framework-specific how-to guides - from best practices to configuration, local development, and more.

| Language | Frameworks |
| :---------------- |:----------------------------------------------------------------------------------------------------------------------------|
| [Python](/languages/python/_index.md) | [Django](/get-started/stacks/django.md)<br/>[Flask](/get-started/stacks/flask.md) |
| [PHP](/languages/php/_index.md) | [Symfony](/get-started/stacks/symfony/_index.md)<br/>[Laravel](/get-started/stacks/laravel.md) |
| [Javascript/Node.js](/languages/nodejs/_index.md) | [Express](/get-started/stacks/express.md)<br/>[Next.js](/get-started/stacks/nextjs.md)<br/>[Strapi](/get-started/stacks/strapi.md) |

### Reference

The **Reference documentation** section is the largest and most comprehensive.
It includes details of configuration, environment variables, activities, and much more material you can use in your day-to-day work.

{{< home/table "services" >}}
{{< home/table "languages" >}}
{{< home/table "configuration" >}}
{{< home/table "topics" >}}

### API documentation

Find out more about {{% vendor/name %}}'s GIT implementation and REST API, and how you can leverage them to manage every aspect of your projects, through {{% vendor/name %}}'s [API documentation](https://api.platform.sh/docs/).

## Connect with us

### Join the community

The {{% vendor/name %}} community meets on both a [Community forum](https://support.platform.sh/hc/en-us/community/topics) and [Discord](https://discord.gg/PkMc2pVCDV) for questions and discussion.

Have an experiment you'd like to share?
Looking for a way to contribute?

<div style="margin-top: 3rem; text-align: center;">
<a class="start-cta font-semibold text-sm xl:text-base px-4 py-2 bg-skye rounded text-white hover:bg-skye-dark focus:bg-skye-dark"
href="https://discord.gg/PkMc2pVCDV" rel="noopener">Join us on Discord</a>
</div>

### Contribute
Feel free to open an issue or pull request for any of the repositories below, or let us know on [Discord](https://discord.gg/PkMc2pVCDV) if you find a problem we can help with:

{{< home/links-github >}}

### Get support

If you're experiencing issues with your projects, don't hesitate to open a [support ticket](/learn/overview/get-support).

4 changes: 2 additions & 2 deletions sites/friday/src/development/file-transfer.md
Original file line number Diff line number Diff line change
Expand Up @@ -160,14 +160,14 @@ For more options, consult the [rsync documentation](https://man7.org/linux/man-p

You can use `sftp` to copy files to and from a remote environment.

{{% note %}}
{{< note >}}
{{% vendor/name %}} supports `sftp`, but the following limitations apply:

- You can only create `sftp` accounts with an existing {{% vendor/name %}} user and an SSH key.
Custom users and passwords aren't supported.
- `sftp` access cannot be limited to a specific directory.
Instead, access is given to **the whole application directory** and its mounts.
{{% /note %}}
{{< /note >}}

#### Open an `sftp` connection

Expand Down
6 changes: 3 additions & 3 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
aliases:
- /get-started/_index.md
---
# aliases:
# - /get-started/_index.md
---
6 changes: 0 additions & 6 deletions sites/friday/src/get-started/django/_index.md

This file was deleted.

Loading
Loading