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 28 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
1 change: 0 additions & 1 deletion sites/friday/config/_default/config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,6 @@ module:
target: "content"
excludeFiles:
- "registry/*"
- "_index.md"
- "get-started/*"
lang: "en"

Expand Down
21 changes: 15 additions & 6 deletions sites/friday/config/_default/params.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -66,21 +66,30 @@ _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

nonDocsSections:
apidocs:
title: API Documentation
link: https://api.platform.sh/docs
weight: -80

# Metadata
meta:
sitename: "Deploy Friday User Documentation"
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
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
26 changes: 20 additions & 6 deletions sites/platform/config/_default/params.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,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 @@ -65,18 +65,32 @@ _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

nonDocsSections:
apidocs:
title: API Documentation
link: https://api.platform.sh/docs
weight: -80
# community:
# title: Community Forum
# link: https://community.platform.sh
# weight: -70

# Metadata
meta:
Expand Down
125 changes: 97 additions & 28 deletions sites/platform/src/_index.md
Original file line number Diff line number Diff line change
@@ -1,47 +1,116 @@
---
title: Introduction
showTitle: false
chadwcarlson marked this conversation as resolved.
Show resolved Hide resolved
editPage: false
feedback: false
---

{{< 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.
{{< home >}}

Check warning on line 8 in sites/platform/src/_index.md

View workflow job for this annotation

GitHub Actions / Lint markdown

Line must be at most 140 characters

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 >}}.
## How the docs are organized

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.
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 >}}.

{{< vendor/name >}} is built on Debian, supports many different programming **Languages** and environments,
and features recommended optimizations for several **Featured Frameworks**.
This site is roughly split into categories based on where you are in your journey working with {{< vendor/name >}}, described below.

Finally, you can also get tips for setting up your own **Development** workflow and **Administering** your {{< vendor/name >}} account.
### Get started

## Git Driven Infrastructure
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.

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

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

{{< 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.
### Learn

Check warning on line 26 in sites/platform/src/_index.md

View workflow job for this annotation

GitHub Actions / Lint markdown

Line must be at most 140 characters

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.
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 >}}.

Check warning on line 29 in sites/platform/src/_index.md

View workflow job for this annotation

GitHub Actions / Lint markdown

Line must be at most 140 characters
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.
- [**What is {{% vendor/name %}}?**](/learn/overview/_index.md)

Check warning on line 31 in sites/platform/src/_index.md

View workflow job for this annotation

GitHub Actions / Lint markdown

Line must be at most 140 characters
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.
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.

{{< vendor/name >}} respects the structure of branches. It's entirely up to you.
- [**Tutorials**](/learn/tutorials/_index.md)

Check warning on line 35 in sites/platform/src/_index.md

View workflow job for this annotation

GitHub Actions / Lint markdown

Line must be at most 140 characters

### Full stack management
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.

Managing your full stack on {{< vendor/name >}} gives you the following unique features:
- [**Best practices**](/learn/bestpractices/_index.md)

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

Check warning on line 43 in sites/platform/src/_index.md

View workflow job for this annotation

GitHub Actions / Lint markdown

Line must be at most 140 characters
The [**Best practices**](/learn/bestpractices/_index.md) documentation contains articles that address advanced use cases for caching, microservices, and more.

Check warning on line 44 in sites/platform/src/_index.md

View workflow job for this annotation

GitHub Actions / Lint markdown

Line must be at most 140 characters

Check warning on line 45 in sites/platform/src/_index.md

View workflow job for this annotation

GitHub Actions / Lint markdown

Line must be at most 140 characters
### Frameworks

Check warning on line 47 in sites/platform/src/_index.md

View workflow job for this annotation

GitHub Actions / Lint markdown

Line must be at most 140 characters
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](/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 **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" >}}

chadwcarlson marked this conversation as resolved.
Show resolved Hide resolved
### 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/).

{{< version/specific >}}

<!-- For now, most of these links are only relevant to Platform.sh -->
### More docs, found elsewhere

There are many resources available outside of the documentation that will help you work with {{< vendor/name >}}, including demos, talks, and podcasts.

[Check them out here](/learn/resources.md).

To stay informed of all the latest {{< vendor/name >}} news, join our newsletter.

<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>

<--->

<!-- TBD: white-label version when available -->

{{< /version/specific >}}


## Connect with us

### 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>

### Contribute
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 >}}

### Get support

If you're experiencing issues with your projects, don't hesitate to open a [support ticket](/learn/overview/get-support).
2 changes: 1 addition & 1 deletion sites/platform/src/add-services/elasticsearch.md
Original file line number Diff line number Diff line change
Expand Up @@ -183,7 +183,7 @@ use the `elasticsearch-enterprise` type.

In this example you'd have the ICU analysis plugin and Python script support plugin.

If there is a publicly available plugin you need that isn't listed here, [contact support](../overview/get-support.md).
If there is a publicly available plugin you need that isn't listed here, [contact support](/learn/overview/get-support.md).

### Available plugins

Expand Down
2 changes: 1 addition & 1 deletion sites/platform/src/add-services/opensearch.md
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ search:

In this example you'd have the ICU analysis plugin and the size mapper plugin.

If there is a publicly available plugin you need that isn't listed here, [contact support](../overview/get-support.md).
If there is a publicly available plugin you need that isn't listed here, [contact support](/learn/overview/get-support.md).

### Available plugins

Expand Down
2 changes: 1 addition & 1 deletion sites/platform/src/administration/organizations.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ platform organization:info --org acme
As an organization owner, you can delete your own organization.

Note that if your organization owns projects or owes remaining invoices, you can not delete it yourself.
To have it deleted, [contact support](../overview/get-support.md).
To have it deleted, [contact support](/learn/overview/get-support.md).

{{< codetabs >}}

Expand Down
2 changes: 1 addition & 1 deletion sites/platform/src/create-apps/hooks/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: Add custom scripts at different stages in the build and deploy proc
layout: single
---

As your app goes through the [build and deploy process](../../overview/build-deploy.md),
As your app goes through the [build and deploy process](/learn/overview/build-deploy.md),
you might want to run custom commands.
These might include compiling the app, setting the configuration for services based on variables, and rebuilding search indexes.
Do these tasks using one of [three hooks](./hooks-comparison.md).
Expand Down
Loading
Loading