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

Add clarity to WPMS documentation about requesting multisites #9332

Merged
merged 25 commits into from
Dec 5, 2024
Merged
Show file tree
Hide file tree
Changes from 14 commits
Commits
Show all changes
25 commits
Select commit Hold shift + click to select a range
f20eb9e
add explanation about why WP sites can't just magically become multis…
jazzsequence Nov 26, 2024
335b8b8
update the custom upstream intro to add glossary terms
jazzsequence Nov 27, 2024
466085a
Merge branch '9333-glossary' into 9252-wpms-framework-clarity
jazzsequence Nov 27, 2024
9c38156
a little more clarity about what settings
jazzsequence Nov 27, 2024
1e1d0d1
remove the note, rephrase
jazzsequence Nov 27, 2024
8374771
remove html formatting
jazzsequence Nov 27, 2024
12c633f
Merge branch '9333-glossary' into 9252-wpms-framework-clarity
jazzsequence Nov 27, 2024
d2805aa
use headings and p tags
jazzsequence Nov 27, 2024
087cfa9
use upstream framework as the term instead
jazzsequence Nov 27, 2024
5ca8c69
rename upstream framework to site framework
jazzsequence Nov 27, 2024
02b811c
site framework doesn't create the glossary page
jazzsequence Nov 27, 2024
342d955
use em tags for emphasis
jazzsequence Nov 27, 2024
eeb256e
Merge branch '9333-glossary' into 9252-wpms-framework-clarity
jazzsequence Nov 27, 2024
90d0f49
link to framework in the glossary
jazzsequence Nov 27, 2024
17da533
add space
jazzsequence Dec 3, 2024
1861ac4
Merge branch 'main' into 9252-wpms-framework-clarity
jazzsequence Dec 4, 2024
602e8d6
fix the link
jazzsequence Dec 4, 2024
e8cd043
Merge branch 'main' into 9252-wpms-framework-clarity
jazzsequence Dec 4, 2024
72c377e
clarify wpms upstream creation
jazzsequence Dec 4, 2024
2e59308
simplify existing wpms conversion description
jazzsequence Dec 4, 2024
c1b2a3c
support creates the upstream, not the multisite itself
jazzsequence Dec 5, 2024
2afe6ca
Minor phrasing change to WPMS upstream access
ccharlton Dec 5, 2024
7d3c2b7
don't say "wordpress network"
jazzsequence Dec 5, 2024
84f1ebc
Update source/content/guides/multisite/01-introduction.md
jazzsequence Dec 5, 2024
ed00e8a
Apply suggestions from code review
jazzsequence Dec 5, 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
32 changes: 25 additions & 7 deletions source/content/guides/custom-upstream/01-custom-upstream.md
Original file line number Diff line number Diff line change
Expand Up @@ -126,20 +126,38 @@ Support for Custom Upstreams requires that the externally hosted upstream reposi

Here are definitions for commonly used terms:

- **Upstream**: A repository that acts as a parent for another repository, like [Pantheon's WordPress Upstream](https://github.com/pantheon-systems/wordpress). The next two definitions are specific types of Upstreams.
### Upstream

- **Custom Upstream**: A repository restricted to members of an organization, containing a common codebase for new sites. This type of repository is a child repository to Pantheon's core upstreams ([WordPress](https://github.com/pantheon-systems/wordpress),[Drupal (Latest Version)](https://github.com/pantheon-upstreams/drupal-composer-managed), [Drupal 7](https://github.com/pantheon-systems/drops-7)) and acts as a parent for site level repositories.
<p>An <dfn id="upstream">upstream</dfn> is a repository that acts as a parent for another repository, like <a href="https://github.com/pantheon-systems/wordpress">Pantheon's WordPress Upstream</a>.</p>

- **Public Upstream**: A repository that is open to all Pantheon users which contains a common codebase for new sites, like [Panopoly](https://github.com/populist/panopoly-drops-7).
### Custom Upstream

- **Repository**: A collection of files packaged in a single directory under version control.
<p>A <dfn id="custom-upstream">custom upstream</dfn> is a repository restricted to members of an organization, containing a common codebase for new sites. This type of repository is a child repository to Pantheon's core upstreams (<a href="https://github.com/pantheon-systems/wordpress">WordPress</a>, <a href="https://github.com/pantheon-upstreams/drupal-composer-managed">Drupal (Latest Version)</a>, <a href="https://github.com/pantheon-systems/drops-7">Drupal 7</a>) and acts as a parent for site level repositories.</p>

- **Remote Repository**: A central version control location, such as a repository residing on GitHub, Bitbucket, or GitLab.
### Public Upstream

- **Upstream Updates**: Code changes that are made once in a parent (upstream) repository, then applied "downstream" to child repositories. This is how Pantheon's one-click updates work.
<p>A <dfn id="public-upstream">public upstream</dfn> is a repository that is open to all Pantheon users which contains a common codebase for new sites, like <a href="https://github.com/populist/panopoly-drops-7">Panopoly</a>.</p>

- **Site Repository**: Child repository where upstream updates are applied and site specific customizations are tracked, similar to your site's codebase on Pantheon.
### Repository

<p>A<dfn id="repository">repository</dfn> is a collection of files packaged in a single directory under version control.</p>
jazzsequence marked this conversation as resolved.
Show resolved Hide resolved


### Remote Repository

<p>A <dfn id="remote-repository">remote repository</dfn> is the central version control location, such as a repository residing on GitHub, Bitbucket, or GitLab.</p>

### Upstream Updates

<p><dfn id="upstream-updates"> Upstream Updates</dfn> are code changes that are made once in a parent (upstream) repository, then applied "downstream" to child repositories. This is how Pantheon's one-click updates work.</p>

### Site Repository

<p>A <dfn id="site-repository">site repository</dfn> is a child repository where upstream updates are applied and site specific customizations are tracked, similar to your site's codebase on Pantheon.</p>

### Framework

<p>The <dfn id="upstream-framework">upstream framework</dfn> (or site framework) determines the server configuration for a given CMS. It includes things like Nginx configuration, the relevant CLI tool to install (Drush or WP-CLI), etc. This setting is <em>not visible</em> to users and once a framework has been set for a site (based on how the upstream was configured), it cannot be changed without <a href="https://docs.pantheon.io/guides/custom-upstream/switch-custom-upstream">changing the upstream</a> itself.</p>

## More Resources

Expand Down
6 changes: 4 additions & 2 deletions source/content/guides/multisite/01-introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,17 +41,19 @@ We do not support uses of WordPress Multisite that run functionally-different or
## Request a WordPress Multisite
WordPress Multisite requires a special configuration that is only available to select customers. Access to WordPress Multisite requires a Gold, Platinum, or Diamond level [Workspace plan](https://pantheon.io/plans/pricing).

By default, Pantheon employees must create new Multisites on your behalf. Reach out to your account manager to request site creation for a new WordPress Multisite.
By default, Pantheon employees must create new Multisites on your behalf. This is because they use a different site [framework](/glossary/#upstream-framework) (which includes server settings like Nginx configuration) than the default `wordpress` framework typically available to customers. Reach out to your account manager to request site creation for a new WordPress Multisite.

If you want to create new WordPress Multisites self-serve and on-demand in the Pantheon Dashboard, reach out to your account manager and request a [Custom Upstream](/guides/custom-upstream) for your workspace based on Pantheon's WordPress Multisite framework.
jazzsequence marked this conversation as resolved.
Show resolved Hide resolved

Existing WordPress sites cannot be converted to a multisite, however they can be [migrated](/migrate-wordpress-multisite).
Setting up an existing WordPress site on Pantheon as a WordPress multisite without the correct framework can result in unexpected errors due to the improper Nginx configuration. If you have an existing WordPress site that you want to make into a multisite but the upstream does not use the `wordpress_network` framework (visible in the Pantheon Dashboard), and a WordPress Multisite upstream has been created for you, you can create a new site based on that upstream and push your codebase pushed to the new site repository (since WordPress Multisite is a core component of WordPress and uses the same code).
jazzsequence marked this conversation as resolved.
Show resolved Hide resolved

If you don't have an account manager, you can [contact sales](https://pantheon.io/contact-us).
jazzsequence marked this conversation as resolved.
Show resolved Hide resolved


## More Resources

- [Migrate a WordPress Multisite onto Pantheon](/migrate-wordpress-multisite)

- [WordPress on Pantheon Quick Start Guide](/guides/wordpress-pantheon/)

- [Supported WordPress Versions](/supported-wp)
Expand Down