4221 improvements to dedicated docs #4249
Conversation
Very rough draft to help with debugging local preview generation issue
* updates /anchors/dns.html to the correct final location * updates /anchors/import-data/mysql.html to the correct final location * updates /anchors/crons/paused.html to the correct final location * updates /anchors/import-data/postgresql.html to the correct final location * corrects landing link for timezone and backup * corrects landing link for flexible resources * corrects landing link for backups because my initial assumption was incorrect * corrects landing link for anchors/observability/metrics/grid
… adds missing list files.
added images, changed titles etc
still need edit other tables
made edits to tables on page
corrected link and removed row from table
Kemi-Elizabeth
requested review from
gilzow and
chadwcarlson
and removed request for
gilzow
added description to index
Updated table with enterprise or elite
There was a problem hiding this comment.
since we've moved this doc location, should we add a redirect for it in routes.yaml?
There was a problem hiding this comment.
similar: since we've moved this doc location, should we add a redirect for it in routes.yaml?
| sidebarTitle: "Differences in development" | ||
| description: See the differences between your Production/Staging environments (which are {{% names/dedicated-gen-2 %}}) and your Development environments (which are Grid environments). | ||
| sidebarTitle: "Environment differences" | ||
| description: See the differences between your Production/Staging environments (which are Dedicated Gen 2) and your Development environments (which are Grid environments). | ||
| --- | ||
|
|
||
| With {{% names/dedicated-gen-2 %}} plans, your Production and Staging environments are dedicated virtual machines, | ||
| while your Development environments run on the Grid, meaning shared redundant infrastructure. |
There was a problem hiding this comment.
should we add a link on "grid" to https://docs.platform.sh/glossary.html#grid ?
sites/platform/src/dedicated-environments/dedicated-gen-2/environment-differences.md
Outdated
Show resolved
Hide resolved
| sidebarTitle: "Differences in development" | ||
| description: See the differences between your Production/Staging environments (which are {{% names/dedicated-gen-2 %}}) and your Development environments (which are Grid environments). | ||
| sidebarTitle: "Environment differences" | ||
| description: See the differences between your Production/Staging environments (which are Dedicated Gen 2) and your Development environments (which are Grid environments). | ||
| --- | ||
|
|
||
| With {{% names/dedicated-gen-2 %}} plans, your Production and Staging environments are dedicated virtual machines, | ||
| while your Development environments run on the Grid, meaning shared redundant infrastructure. | ||
| This difference means a few configuration options and tools function differently in the different environments. |
There was a problem hiding this comment.
do we have docs on the specific configuration options/tools that are different between the environments? if so, we should link to them here.
| | **Environment clone** | Yes on all branches | Only on Development environments | | ||
| | **MySQL Replication** | None: standalone service container | Yes: 3 services nodes cluster | | ||
| | **Redis Replication** | None: standalone service container | Yes: 3 services nodes cluster | | ||
| | **MongoDB** | Standalone service container | Yes | |
There was a problem hiding this comment.
we have "yes" under Dedicated but in the DG2 overview for MongoDB we have "Not supported" and it's not listed at all on the DG3 overview.
There was a problem hiding this comment.
We need to verify this one
There was a problem hiding this comment.
Just clarified with the mega spreadsheet I was working from. It had "in progress" in some places and "not supported in others". I've put it down as a no in all cases as now :)
| | **Routes management** | Autonomous | Autonomous | | ||
| | **Crons management** | Autonomous | Autonomous | | ||
| | **Crons tasks interrupted by deploys** | No: a running cron task will block a deployment until it is complete | Yes: a deploy will terminate a running cron task | | ||
| | **Mounts management** | Autonomous | Either autonomous or manual | |
There was a problem hiding this comment.
for dedicated we have "Either autonomous or manual" but I think what we mean here is autonomous or requires a support ticket" since the DG2 page states
Storage: Storage allocation between mounts, DB and services is done through Platform.sh once a ticket is raised. Storage management is not self-service.
There was a problem hiding this comment.
What if we make it
Managed by Platform.sh (Dedicated Gen 2 only)
?
sites/platform/src/dedicated-environments/security-monitoring.md
Outdated
Show resolved
Hide resolved
|
|
||
| ### Encryption | ||
|
|
||
| | AWS | GCP | Azure | |
There was a problem hiding this comment.
I think the GCP and Azure headers are flipped? The description below GCP seems like it is the description for Azure.
There was a problem hiding this comment.
I think you're right
There was a problem hiding this comment.
Removed this section and linked to https://platform.sh/trust-center/security/encryption/ instead!
sites/platform/src/dedicated-environments/security-monitoring.md
Outdated
Show resolved
Hide resolved
sites/platform/src/dedicated-environments/dedicated-gen-2/development.md
Outdated
Show resolved
Hide resolved
sites/platform/src/dedicated-environments/security-monitoring.md
Outdated
Show resolved
Hide resolved
sites/platform/src/dedicated-environments/security-monitoring.md
Outdated
Show resolved
Hide resolved
sites/platform/src/dedicated-environments/security-monitoring.md
Outdated
Show resolved
Hide resolved
sites/platform/src/dedicated-environments/security-monitoring.md
Outdated
Show resolved
Hide resolved
| @@ -0,0 +1 @@ | |||
| NAMES/DEDICATED TBD | |||
There was a problem hiding this comment.
If we're still using this shortcode, we need to agree on something here or remove.
…ronment-differences.md Co-authored-by: Chad Carlson <[email protected]>
…view.md Co-authored-by: Paul Gilzow <[email protected]>
Co-authored-by: Chad Carlson <[email protected]>
Co-authored-by: Chad Carlson <[email protected]>
Co-authored-by: Chad Carlson <[email protected]>
Co-authored-by: Paul Gilzow <[email protected]>
Co-authored-by: Chad Carlson <[email protected]>
…lopment.md Co-authored-by: Chad Carlson <[email protected]>
Co-authored-by: Chad Carlson <[email protected]>
Co-authored-by: Chad Carlson <[email protected]>
Co-authored-by: Chad Carlson <[email protected]>
…view.md Co-authored-by: Chad Carlson <[email protected]>
Co-authored-by: Chad Carlson <[email protected]>
Co-authored-by: Chad Carlson <[email protected]>
Co-authored-by: Chad Carlson <[email protected]>
Co-authored-by: Chad Carlson <[email protected]>
Co-authored-by: Chad Carlson <[email protected]>
Co-authored-by: Chad Carlson <[email protected]>
Co-authored-by: Chad Carlson <[email protected]>
…view.md Co-authored-by: Paul Gilzow <[email protected]>
…view.md Co-authored-by: Paul Gilzow <[email protected]>
…com/platformsh/platformsh-docs into 4221-improvements-to-dedicated-docs
Co-authored-by: Paul Gilzow <[email protected]>
Co-authored-by: Paul Gilzow <[email protected]>
made suggested changes
…com/platformsh/platformsh-docs into 4221-improvements-to-dedicated-docs
made changes
…view.md Co-authored-by: Paul Gilzow <[email protected]>
…view.md Co-authored-by: Paul Gilzow <[email protected]>
made changes suggested by Paul and Chad.
…com/platformsh/platformsh-docs into 4221-improvements-to-dedicated-docs
added glossary terms and made changes based on Jonas clarification
made more changes
sites/platform/src/dedicated-environments/dedicated-gen-2/development.md
Outdated
Show resolved
Hide resolved
made last bits of changes
More changes
Corrected inconsistencies with capitals
changed shortcode - not sure if we reference it though?
…com/platformsh/platformsh-docs into 4221-improvements-to-dedicated-docs
Why
Closes #4221
What's changed
Added more pages and diagrams, and also changed the set up of the Dedicated Environments section.
Where are changes
The changes are all the Dedicated Environments section.
Updates are for:
[] platform (
sites/platformtemplates)[] upsun (
sites/upsuntemplates)