Skip to content

Commit

Permalink
Merge pull request platformsh#3353 from platformsh/vendor/3352-name
Browse files Browse the repository at this point in the history
Substitute vendor naming for white-label
  • Loading branch information
gilzow authored Aug 15, 2023
2 parents 90dcc2f + 30df99d commit b51df24
Show file tree
Hide file tree
Showing 356 changed files with 1,348 additions and 2,393 deletions.
2 changes: 1 addition & 1 deletion contributing/styles/Platform/link-text.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ message: "Try to use meaningful text for links."
link: "https://github.com/platformsh/platformsh-docs/blob/main/contributing/content-style.md#use-meaningful-link-text"
level: warning
nonword: true
scope: link
scope: raw
tokens:
- \b(?<!t)here\b
- click here
2 changes: 2 additions & 0 deletions contributing/styles/Vocab/Platform/accept.txt
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ async
Asyncio
auditable
autoload(?:er|ing)?
[Aa]utoscaling
Blackfire
blockquote
Bootsnap
Expand Down Expand Up @@ -75,6 +76,7 @@ Mailchimp
[Mm]ebibyte
Meilisearch
Memcache
Mercure
Mezmo
middleware
Miniconda
Expand Down
2 changes: 2 additions & 0 deletions contributing/styles/Vocab/Platform/reject.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,5 @@ configuation
MongDB
postgreSQL
strapi

Platform.sh
2 changes: 1 addition & 1 deletion sites/friday/ABOUT.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Self-indexing `docs` for `search`

Hugo allows you to define custom output formats besides HTML. We've defined a `json` output format as well for the root `_index.md` location, which uses the files below to index the documentation itself and serve that index at `docs.platform.sh/index.json` (`public/index.json` when built). Comments are placed here rather than inline so they do not affect the template formatting in these individual partials during builds.
Hugo allows you to define custom output formats besides HTML. We've defined a `json` output format as well for the root `_index.md` location, which uses the files below to index the documentation itself and serve that index at `[vendor_url]/index.json` (`public/index.json` when built). Comments are placed here rather than inline so they do not affect the template formatting in these individual partials during builds.

- `config/_default/config.yaml`: The `json` output format is defined, but only for `home` (`_index.md`).
- `layouts/partials/meilindex/fields/section.html`: Subsections need special handling to show their subsection header in search results rather than the top-level section.
Expand Down
29 changes: 20 additions & 9 deletions sites/friday/config/_default/params.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,18 @@ vendor:
name: Deploy Friday
cli: friday
env_prefix: FRIDAY
urls:
main: https://deployfriday.net/
docs: https://docs.deployfriday.net/
support: https://support.deployfriday.net/
sales: https://deployfriday.net/contact
console: https://console.deployfriday.net/
api: https://api.deployfriday.net/
config_dir: .friday
files:
routes: .friday/config.yaml
services: .friday/config.yaml
apps: .friday/config.yaml

# Images (kept in static/)
logo: "images/logo.svg"
Expand Down Expand Up @@ -64,17 +75,17 @@ navSections:

# Metadata
meta:
sitename: "Platform.sh User Documentation"
description: Platform.sh 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.
image: "https://docs.platform.sh/images/logos/docs_social_2021.jpg"
url: "https://docs.platform.sh"
sitename: "Deploy Friday User Documentation"
description: Deploy Friday 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.
image: "https://docs.deployfriday.net/images/logos/docs_social_2021.jpg"
url: "https://docs.deployfriday.net"
twittercard:
card: "summary_large_image"
site: "@platformsh"
title: "Platform.sh User Documentation"
description: "Platform.sh 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."
creator: "@platformsh"
image: "https://docs.platform.sh/images/logos/docs_social_2021.jpg"
site: "@deployfriday"
title: "Deploy Friday User Documentation"
description: "Deploy Friday 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."
creator: "@deployfriday"
image: "https://docs.deployfriday.net/images/logos/docs_social_2021.jpg"
keywords:
- PaaS
- cloud hosting
Expand Down
4 changes: 2 additions & 2 deletions sites/friday/package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "platformsh-docs",
"name": "platformsh-docs-whitelabel",
"version": "1.0.0",
"description": "This repository holds the public user documentation for [Platform.sh](https://platform.sh/).",
"description": "This repository holds the public user documentation for white-labeled [Platform.sh](https://platform.sh/).",
"license": "CC-BY-NC-SA-4.0",
"repository": {
"type": "git",
Expand Down
16 changes: 8 additions & 8 deletions sites/friday/src/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,25 +11,25 @@ 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.

If you're new to Platform.sh, 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 Platform.sh.
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 >}}.

The main requirement of Platform.sh is that you use Git to manage your application code.
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.

Platform.sh is built on Debian, supports many different programming **Languages** and environments,
{{< vendor/name >}} is built on Debian, supports many different programming **Languages** and environments,
and features recommended optimizations for several **Featured Frameworks**.

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

### Git Driven Infrastructure

As a Platform as a Service, or PaaS, Platform.sh automatically manages everything your application needs to run.
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

Platform.sh 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.
{{< 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.
Expand All @@ -40,11 +40,11 @@ It really is "what would my site look like if I merged this to production?" ever

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.

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

### Full stack management

Managing your full stack on Platform.sh gives you the following unique features:
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.
Expand Down
Loading

0 comments on commit b51df24

Please sign in to comment.