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

Guides reorganization for initial IA + vendorization #3368

Merged
merged 30 commits into from
Sep 8, 2023
Merged
Show file tree
Hide file tree
Changes from 16 commits
Commits
Show all changes
30 commits
Select commit Hold shift + click to select a range
83ad2c9
Sidebar updates. Move best-practices, tutorials into 'learn'.
chadwcarlson Aug 18, 2023
4239518
Fix new 'book' item-is-active issue.
chadwcarlson Aug 18, 2023
7b11bf6
Fix new 'book' item-is-active issue.
chadwcarlson Aug 18, 2023
2244a49
Overview/homepage reorg.
chadwcarlson Aug 18, 2023
52a3877
Flush out a homepage to start working from.
chadwcarlson Aug 21, 2023
6fb01cc
Remove previous overview section. Fix links. Fix homepage sidebar logic.
chadwcarlson Aug 21, 2023
b45c38c
address #2972 - remove 3rd part resources.
chadwcarlson Aug 21, 2023
57616ac
Now that there's a homepage, the logo links back to it.
chadwcarlson Aug 21, 2023
2f5165f
Resolve white-label site given changes.
chadwcarlson Aug 21, 2023
8e651a7
Fix Vale errors.
chadwcarlson Aug 21, 2023
9e8c45a
Homepage title fix.
chadwcarlson Aug 21, 2023
bbaf6d7
Add P.sh redirects for moved guides.
chadwcarlson Aug 21, 2023
2342a1c
Merge branch 'main' into vendor/3348-guides
chadwcarlson Aug 21, 2023
cfb1392
Anchor the front.
chadwcarlson Aug 22, 2023
4a4befe
Add a link back to home.
chadwcarlson Aug 22, 2023
776fa06
Merge branch 'main' into vendor/3348-guides
chadwcarlson Aug 22, 2023
b0fed7a
Address review suggestions.
chadwcarlson Aug 23, 2023
3310572
API docs in sidebar - avoid 'Reference' expectation confusion.
chadwcarlson Aug 23, 2023
f3f81ac
Merge branch 'main' into vendor/3348-guides
chadwcarlson Aug 23, 2023
1b34702
Apply suggestions.
chadwcarlson Sep 1, 2023
ccf66de
fix internal links.
chadwcarlson Sep 1, 2023
69584a2
Merge branch 'main' into vendor/3348-guides
chadwcarlson Sep 1, 2023
8074e9f
Address single Vale error.
chadwcarlson Sep 1, 2023
0c7d058
add an allow for the Postgres that snuck by in PR#3391
chadwcarlson Sep 1, 2023
52af584
Revert last two commits in favor of separate PR.
chadwcarlson Sep 1, 2023
10b3a7c
Merge branch 'main' into vendor/3348-guides
chadwcarlson Sep 1, 2023
e69f435
Merge branch 'main' into vendor/3348-guides
chadwcarlson Sep 7, 2023
15b3381
Address feedback.
chadwcarlson Sep 7, 2023
204cf45
Merge branch 'main' into vendor/3348-guides
chadwcarlson Sep 8, 2023
eaec4c0
Apply Paul's redirect config suggestions.
chadwcarlson Sep 8, 2023
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
5 changes: 5 additions & 0 deletions .platform/routes.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -247,6 +247,11 @@ https://{default}/:
# Sponsored sites application
"/administration/pricing/sponsored.html": { "to": "/administration/pricing#sponsored-sites", "code": 301 }

# Overview, tutorials, and best-practices redirects (Aug 2023)
"^/bestpractices(.*)": { "to": "/learn/bestpractices$1", "code": 301, "regexp": true }
chadwcarlson marked this conversation as resolved.
Show resolved Hide resolved
"^/tutorials(.*)": { "to": "/learn/tutorials$1", "code": 301, "regexp": true }
"^/overview(.*)": { "to": "/learn/overview$1", "code": 301, "regexp": true }

"https://search.{default}/":
type: upstream
upstream: "search:http"
Expand Down
16 changes: 10 additions & 6 deletions sites/friday/config/_default/params.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -65,20 +65,24 @@ _404:
image: "/images/404/404-8.png"
issues: "https://github.com/platformsh/platformsh-docs/issues/new"

# Sections in the navigation sidebar
navSections:
home:
title: Guides and reference
section: home
weight: -120
get-started:
title: Get started
section: get-started
weight: -120
learn:
title: Learn
section: learn
weight: -110
guides:
title: Stacks
title: Frameworks
section: guides
weight: -100
home:
title: Reference
section: home
weight: -90


# Metadata
meta:
Expand Down
68 changes: 18 additions & 50 deletions sites/friday/layouts/shortcodes/home.html
Original file line number Diff line number Diff line change
@@ -1,60 +1,22 @@
<div class="home-hero" style="text-align: center; padding: 5rem 2rem;">
<div class="home-hero" style="text-align: center; padding: 4rem 2rem 4rem 2rem;">

<h3>Welcome to the</h3>
<h1>{{ .Site.Params.vendor.name }} Developer Center</h1>
<h1>{{ .Site.Title }}</h1>

<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer dictum mauris id tincidunt gravida. Suspendisse sagittis euismod mi. Aliquam erat volutpat. Donec venenatis quam non nisi molestie malesuada.</p>
<p>Nam egestas eros vitae orci cursus tincidunt. Duis vel sodales nulla. </p>
<p>Built for developers, by developers. The efficient, reliable, and secure Platform-as-a-Service (PaaS) that gives development teams control and peace of mind while accelerating the time it takes to build and deploy applications.</p>

<p>Resources to help you customize, experiment, and optimize all from one platform.</p>

<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>
<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="/#{{ printf "What is %s?" .Site.Params.vendor.name | anchorize }}" rel="noopener">What is {{ .Site.Params.vendor.name }}?</a>
href="/learn/overview.html" rel="noopener">What is {{ .Site.Params.vendor.name }}?</a>
</div>


</div>

<div class="home-resources">
<h2>Join our community and navigate developer resources</h2>
<table class="tg">
<thead>
<tr>
<th class="tg-0lax">Configuration</th>
<th class="tg-0lax">Community</th>
<th class="tg-0lax">Topics</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tg-0lax">
<ul class="resource-list">
<li><a href="/create-apps.html">Applications</a></li>
<li><a href="/define-routes.html">Routes</a></li>
<li><a href="/add-services.html">Services</a></li>
</ul>
</td>
<td class="tg-0lax">
<ul class="resource-list">
<li><a href="#">Discord</a></li>
<li><a href="#">Forum</a></li>
<li><a href="/overview/get-support.html">Get support</a></li>
</ul>
</td>
<td class="tg-0lax">
<ul class="resource-list">
<li><a href="/administration.html">Administration</a></li>
<li><a href="/integrations.html">Integrations</a></li>
<li><a href="/increase-observability.html">Observability</a></li>
</ul>
</td>
</tr>
</tbody>
</table>
</div>


<style>
.home-resources {
text-align: center;
Expand All @@ -74,19 +36,24 @@ <h2>Join our community and navigate developer resources</h2>
}

.start-cta {
color: white !important;
/* 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: #6046FF !important; */
background: #FFBDBB!important;
padding: 10px 16px !important;
margin-right: 1rem;
border-radius: 80px !important;
border-radius: 0px !important;
/* border-radius: 80px !important; */
}
.start-cta:hover {
background: #4D38CC !important;
color: white !important;
/* background: #4D38CC !important; */
background: #FF9F9F !important;
color: #191C1E !important;
/* color: white !important; */
}

.info-cta {
Expand All @@ -97,7 +64,8 @@ <h2>Join our community and navigate developer resources</h2>
letter-spacing: 0.48px !important;
background: white !important;
padding: 10px 16px !important;
border-radius: 80px !important;
/* border-radius: 80px !important; */
border-radius: 0px !important;
border: 2px solid #191C1E;
border-color: #191C1E !important;
}
Expand Down
141 changes: 100 additions & 41 deletions sites/friday/src/_index.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,116 @@
---
title: Introduction
showTitle: false
editPage: false
feedback: false
---

{{< home >}}

## What is Deploy Friday?
## How the docs are organized

{{< vendor/name >}} is a second-generation Platform-as-a-Service built especially for continuous deployment.
It allows you to host web applications on the cloud while making your development and testing workflows more productive.
There are different [kinds](https://documentation.divio.com/) of documentation.
Some docs are useful when you are just starting out,
chadwcarlson marked this conversation as resolved.
Show resolved Hide resolved
while others go into detail that's relevant only after you've deployed many projects on {{< vendor/name >}}.

If you're new to {{< vendor/name >}}, we recommend starting with the **Big Picture**, in particular [Structure](/overview/structure.md), and [Build & Deploy](/overview/build-deploy.md) will get you started on the right track to best use {{< vendor/name >}}.
This site is roughly split into four categories of content based on where you are in your journey working with {{< vendor/name >}}, described below.
chadwcarlson marked this conversation as resolved.
Show resolved Hide resolved

The main requirement of {{< vendor/name >}} is that you use Git to manage your application code.
Your project's configuration is driven almost entirely by a small number of YAML files in your Git repository.
The **Configuration** section covers those in more detail and can serve as both a tutorial and a quick reference.
### Get started

{{< vendor/name >}} is built on Debian, supports many different programming **Languages** and environments,
and features recommended optimizations for several **Featured Frameworks**.
If you've come to this site with only a little familiarity 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.
chadwcarlson marked this conversation as resolved.
Show resolved Hide resolved

Finally, you can also get tips for setting up your own **Development** workflow and **Administering** your {{< vendor/name >}} account.
You'll learn the basics of how {{< vendor/name >}} leveraged Git to produce reusable build images, identical environments in staging and development to production (including production data), as well as the basics of monitoring and troubleshooting your environments.
chadwcarlson marked this conversation as resolved.
Show resolved Hide resolved

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

### Learn

After going through the **Get started** section, you may be interested in some more information about how exactly {{< vendor/name >}} works, and why it works the way that it does. The **[Learn](/learn/_index.md)** section of the documentation it a collection of tutorials and conceptual guides that try to help you understand that much more about {{< vendor/name >}}.
chadwcarlson marked this conversation as resolved.
Show resolved Hide resolved

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

This guide focuses on answering one question - what is the problem {{< vendor/name >}} is trying to solve?
Here you'll learn more about {{< vendor/name >}}'s how configuration, build and deploy pipelines, and the structure of environments play into the broader philosophy behind reliably deploying applications.
chadwcarlson marked this conversation as resolved.
Show resolved Hide resolved

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

After you've familiarized yourself with {{< vendor/name >}}, it's 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, the [**Tutorials**](/learn/tutorials/_index.md) will give you all the information you need.
chadwcarlson marked this conversation as resolved.
Show resolved Hide resolved

- [**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 a number of articles that address advanced use cases for caching, microservices, and more.
chadwcarlson marked this conversation as resolved.
Show resolved Hide resolved

### Frameworks

Once you've familiarized yourself with the basic rules of {{< vendor/name >}}, you'll likely want to deploy some of your own custom code in a chosen framework.
The **Frameworks** section of the documentation contains a collection of framework-specific how-to guides - from best practices, configuration, local development, and more.
chadwcarlson marked this conversation as resolved.
Show resolved Hide resolved

| Language | Frameworks |
| :---------------- | :------ |
| [Python](/languages/python/_index.md) | [Django](/guides/django/_index.md) |
| [PHP](/languages/php/_index.md) | [Drupal](/guides/drupal9/_index.md)<br/>[Ibexa](/guides/ibexa/_index.md)<br/>[Laravel](/guides/laravel/_index.md)<br/>[Symfony](/guides/symfony/_index.md)<br/>[TYPO3](/guides/typo3/_index.md)<br/>[WordPress](/guides/wordpress/_index.md) |
| [Javascript/Node.js](/languages/nodejs/_index.md) | [Gatsby](/guides/gatsby/_index.md)<br/>[Next.js](/guides/nextjs/_index.md)<br/>[Strapi](/guides/strapi/_index.md) |
| [Java](/languages/java/_index.md) | [Hibernate](/guides/hibernate/_index.md)<br/>[Jakarta](/guides/jakarta/_index.md)<br/>[Micronaut](/guides/micronaut/_index.md)<br/>[Quarkus](/guides/quarkus/_index.md)<br/>[Spring](/guides/spring/_index.md) |

### Reference

The largest section of the documentation, and the content you'll likely spend the most time, is **Reference documentation**.
It's here that details of configuration, environment variables, activities, and more topics you'll use in your day-to-day work can be found.
chadwcarlson marked this conversation as resolved.
Show resolved Hide resolved

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

### More docs, found elsewhere

There are other forms of documentation that don't fit neatly into the categories above, but are nonetheless helpful resources for working with {{< vendor/name >}}.
Some of the bigger ones are listed below:
chadwcarlson marked this conversation as resolved.
Show resolved Hide resolved

| Source | Links |
| :---------------- | :------ |
| [{{< vendor/name >}} Blog](https://platform.sh/blog) | {{< home/links-blog >}} |
| [Blackfire.io resources](https://platform.sh/blog) | {{< home/links-blackfire >}} |
| [DDEV resources](https://platform.sh/blog) | {{< home/links-ddev >}} |
| [YouTube](https://www.youtube.com/@Platformsh) | {{< home/links-youtube >}} |
| [GitHub](https://github.com/platformsh) | {{< home/links-github >}} |

Stay informed of all the latest {{< vendor/name >}} news by joining our newsletter.
chadwcarlson marked this conversation as resolved.
Show resolved Hide resolved

<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://platform.sh/preferences/" rel="noopener">Sign up for the newsletter</a>
</div>


## Getting help & contributing
chadwcarlson marked this conversation as resolved.
Show resolved Hide resolved

### Join the community

The {{< vendor/name >}} community meets on both a [Community forum](https://community.platform.sh) and [Slack](https://chat.platform.sh) 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://chat.platform.sh" rel="noopener">Join us on Slack</a>
</div>

### How to contribute
chadwcarlson marked this conversation as resolved.
Show resolved Hide resolved

Feel free to open an issue or pull request for any of the repositories below, or let us know on [Slack](https://chat.platform.sh) if you find a problem we can help with:

{{< home/links-github >}}

### Support
chadwcarlson marked this conversation as resolved.
Show resolved Hide resolved

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

## Config snippets
chadwcarlson marked this conversation as resolved.
Show resolved Hide resolved

### `app` file

Expand Down Expand Up @@ -127,34 +217,3 @@ web:
{{% /snippet %}}
{{% snippet placeholder="true" /%}}
{{% snippet placeholder="true" config="service" /%}}
```

### Git Driven Infrastructure

As a Platform as a Service, or PaaS, {{< vendor/name >}} automatically manages everything your application needs to run.
That means you can, and should, view your infrastructure needs as part of your application and address them under version control.

### Infrastructure as code

{{< vendor/name >}} covers not only all of your hosting needs but also most of your DevOps needs. It is a single tool that covers the application life-cycle from development to production and scaling.

You only need to write your code, including a few YAML files that specify your desired infrastructure, commit it to Git, and push.
You don't need to set up anything manually. The web server is already set up and configured, as is any database, search engine, or cache that you specify.

Every branch you push can be made a fully independent environment&mdash;complete with your application code, a copy of your database, a copy of your search index, a copy of your user files, everything.
Its automatically generated URL can be sent to stakeholders or automated CI systems.
It really is "what would my site look like if I merged this to production?" every time.

You can use these concepts to replicate a traditional development/staging/production workflow or even to give every feature its own effective staging environment before merging to production (empowering you to use git-flow like methodologies even better). You could also have an intermediary integration branch for several other branches.

{{< vendor/name >}} respects the structure of branches. It's entirely up to you.

### Full stack management

Managing your full stack on {{< vendor/name >}} gives you the following unique features:

1. **Unified Environment:** All of your services (MySQL, ElasticSearch, MongoDB, etc.) are managed inside the cluster and included in the price, with no external single-points-of-failure. When you back up an environment, you get a fully consistent snapshot of your whole application.
2. **Multi-Services & Multi-App:** You can deploy multiple applications (for example, in a microservice-based architecture), using multiple data backends (MySQL, PostgreSQL, Redis, etc.) written in multiple frameworks (Drupal + NodeJS + Flask, for example) in multiple languages, all in the same cluster.
3. **Full Cluster Cloning Technology:** The full production cluster can be cloned in under a minute&mdash;including all of its data&mdash;to create on-the-fly, ephemeral development environments that are a byte-level copy of production.
4. **Fail-Proof Deployments:** Every time you test a new feature, you also test the deployment process.
5. **Continuous Deployment from the Start:** Everything is build-oriented, with a consistent, repeatable build process, simplifying the process of keeping your application up-to-date and secure.
2 changes: 1 addition & 1 deletion sites/platform/config/_default/config.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Basics
baseURL: /
title: Platform.sh Docs
title: Platform.sh Documentation
author: Platform.sh
description: Platform.sh User Documentation

Expand Down
16 changes: 10 additions & 6 deletions sites/platform/config/_default/params.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ vendor:

# Images (kept in static/)
logo: "images/logos/Platformsh_logo_white.svg"
logolinksto: "https://platform.sh"
logolinksto: "/"
logoAlt: "Platform.sh"
favicon: "images/logos/favicon.ico"

Expand Down Expand Up @@ -64,18 +64,22 @@ _404:

# Sections in the navigation sidebar
navSections:
home:
title: Guides and reference
section: home
weight: -120
get-started:
title: Get started
section: get-started
weight: -120
learn:
title: Learn
section: learn
weight: -110
guides:
title: Stacks
title: Frameworks
section: guides
weight: -100
home:
title: Reference
section: home
weight: -90

# Metadata
meta:
Expand Down
Loading
Loading