Skip to content

Commit

Permalink
Merge pull request #174 from humanmade/backport-172-to-v5-branch
Browse files Browse the repository at this point in the history
[Backport v5-branch] 471 docs fixes
  • Loading branch information
roborourke authored Nov 6, 2020
2 parents c3aea42 + ffc3517 commit 97dbd77
Show file tree
Hide file tree
Showing 7 changed files with 13 additions and 13 deletions.
4 changes: 2 additions & 2 deletions other-docs/getting-started/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ order: 20
---
# Configuration

Configuration of Altis is done the `composer.json` file in the root of your project. To configure specific modules, feature and settings for Altis, add an `extra.altis` section to your `composer.json`.
Configuration of Altis is done via the `composer.json` file in the root of your project. To configure specific modules, features and settings for Altis, add an `extra.altis` section to your `composer.json`.

```
{
Expand All @@ -21,7 +21,7 @@ Configuration of Altis is done the `composer.json` file in the root of your proj
```

When documentation refers to the configuration file, its referring to this section of the `composer.json` file.
When documentation refers to the configuration file, it's referring to this section of the `composer.json` file.

By convention, most module's settings reside in the path `altis.modules.$module.$setting`. For example, to require all users be logged in to view the website, you'd set the `modules.security.require-login` setting to `true`.

Expand Down
2 changes: 1 addition & 1 deletion other-docs/getting-started/third-party-plugins.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ order: 40

Altis is built atop the open-source WordPress CMS. In addition to custom Altis modules, you can also use third-party WordPress plugins to take advantage of the open-source ecosystem.

There are two ways to add plugins to your project: either commit the plugin to your project (or use submodules), or manage it via Composer.
There are two ways to add plugins to your project: either by managing them via Composer, or commit the plugins to your project (or use submodules).


## Managing Plugins via Composer
Expand Down
4 changes: 2 additions & 2 deletions other-docs/guides/headless/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ A semi-decoupled architecture is a hybrid architecture incorporating parts of bo

With a semi-decoupled system, the frontend is built as a part of the application, but has only a few, well-defined integration points between the frontend and backend. These are kept small and manageable to allow teams to work mostly independently. The frontend is built in JavaScript, allowing in-browser rendering in combination with [server-side rendering](ssr.md). Both the frontend and backend run on the same infrastructure.

Altis provides a REST API to allow building semi-decoupled frontends, in addition to tools and libraries to facilitate building these frontends. The [Building a React App guide](react-app.md) guide walks through building a semi-decoupled React app from scratch.
Altis provides a REST API to allow building semi-decoupled frontends, in addition to tools and libraries to facilitate building these frontends. The [Building a React App guide](react-app.md) walks through building a semi-decoupled React app from scratch.

Additionally, Altis provides infrastructure to allow for [server-side rendering](ssr.md).

Expand All @@ -53,6 +53,6 @@ Many of the features provided by the CMS module (and WordPress) are not availabl

Decoupling can also have overhead as compared to monolithic systems, as data needs to be passed between multiple systems. This can cause both technical overhead with latency on round-trips, as well as mental overhead during development, as systems need to be specifically built to accomodate this. Consider whether the additional development time is worth the cost of decoupling.

In many cases, a semi-decoupled architecture can achieve the best of both worlds. This uses parts of the theming system for some frontend functionality, while moving much of the work off to a separate frontend. This can help avoid duplication across systems while still providing many of the benefits of a decoupled architecture. In combination with server-side rendering, data can be generated at the same time as rendering the frontend for users, providing an fluid interactive experience to users with little overhead.
In many cases, a semi-decoupled architecture can achieve the best of both worlds. This uses parts of the theming system for some frontend functionality, while moving much of the work off to a separate frontend. This can help avoid duplication across systems while still providing many of the benefits of a decoupled architecture. In combination with server-side rendering, data can be generated at the same time as rendering the frontend for users, providing a fluid interactive experience to users with little overhead.

Generally, we recommend using a semi-decoupled architecture, but each case is different. The Altis team can provide consultancy and support to guide you through this process.
2 changes: 1 addition & 1 deletion other-docs/guides/headless/react-app.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ mv react-wp-scripts.php inc/loader.php

On your local site, head to [Network Admin > Themes](internal://network-admin/themes.php) and Network Enable the new "Example Headless Theme" entry. This will make the theme usable on your sites.

Next, head to the [Appearance page](internal://admin/themes.php) on a test site and Activate the "Example Headless Theme". This will activate the theme on your site.
Next, head to the [Appearance page](internal://admin/themes.php) on a test site and activate the "Example Headless Theme". This will activate the theme on your site.

Open [the frontend](internal://home/) and you should see an unstyled example page.

Expand Down
4 changes: 2 additions & 2 deletions other-docs/guides/headless/ssr.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ import App from './App';
render( () => <App /> );
```

You do not need to provide a root container ID, as this will provided by the PHP framework.
You do not need to provide a root container ID, as this will be provided by the PHP framework.


## Enabling server-side rendering
Expand Down Expand Up @@ -90,7 +90,7 @@ Refresh the page and view the page's source. You should see your application ren

## Limitations

react-wp-ssr comes with [several limitations](https://github.com/humanmade/react-wp-ssr/blob/master/docs/limitations.md) that you should be aware of. Most well-built applications will work without any modifications, but some applications may require modifications to adapt to these modifications.
react-wp-ssr comes with [several limitations](https://github.com/humanmade/react-wp-ssr/blob/master/docs/limitations.md) that you should be aware of. Most well-built applications will work without any modifications, but some applications may require modifications to adapt to these limitations.

For questions about adapting your application to server-side rendering, consult the Altis team.

Expand Down
2 changes: 1 addition & 1 deletion other-docs/guides/long-term-support.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ For example, if Altis has quarterly releases (i.e. four releases per year), each

## Long-term support policy

The long-term support policy will provide limited support for older releases, while still providing a stable and secure product.
The long-term support (LTS) policy will provide limited support for older releases, while still providing a stable and secure product.

Releases covered by this policy will only receive bugfix updates, and will not receive new features. These bugfix updates will be provided to ensure stability of existing sites.

Expand Down
8 changes: 4 additions & 4 deletions other-docs/guides/migrating-from-wordpress.md
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ Altis uses the standard WordPress must-use plugins directory of `content/mu-plug

## Add composer install to the build script

If you project was not previously using composer, you'll need to add a `composer install --no-dev` to your projects `.build-script`. Simply add the following line to your `.build-script` or create that file if it doesn't already exist.
If your project was not previously using composer, you'll need to add a `composer install --no-dev` to your project's `.build-script`. Simply add the following line to your `.build-script` or create that file if it doesn't already exist.

```sh
composer install --no-dev
Expand Down Expand Up @@ -152,7 +152,7 @@ To start the docker server run `composer local-server start`. You should now be

## Migrating email sending domain

It's quite possible your project specifies the wp mail sending domain via the `wp_mail_from` hook. This can now be specified as setting in the `composer.json`'s `extra.altis.modules.cloud.email.email-from-address` setting:
It's quite possible your project specifies the wp mail sending domain via the `wp_mail_from` hook. This can now be specified as setting in the `composer.json`'s `extra.altis.modules.cloud.email-from-address` setting:

```json
{
Expand All @@ -166,7 +166,7 @@ It's quite possible your project specifies the wp mail sending domain via the `w

## Optionally disable Altis branding

As this guide is for migrating a non-Altis project to use Altis, it's possible the client relationship and understanding does warrant changing anything visible or user-facing. If you are sure this is an "under the hood" migration, and the client has not been on-boarded with Altis as a brand, you can disable the branding via the `altis.modules.cms.branding` setting:
As this guide is for migrating a non-Altis project to use Altis, it's possible the client relationship and understanding does not warrant changing anything visible or user-facing. If you are sure this is an "under the hood" migration, and the client has not been on-boarded with Altis as a brand, you can disable the branding via the `altis.modules.cms.branding` setting:

```json
{
Expand Down Expand Up @@ -200,6 +200,6 @@ Any module can be disabled by setting its `enabled` setting to `false`:

## Deploying to Cloud

The first time Altis is deployed, depending on the exact configuration, there may be tasks to perform on deploy. Altis is always configured to be a WordPress multisite, as such any sites that are not on installed as Multisite already, will need converting via the `multisite-convert` WP CLI command.
The first time Altis is deployed, depending on the exact configuration, there may be tasks to perform on deploy. Altis is always configured to be a WordPress multisite, as such any sites that are not installed as multisite already, will need converting via the `multisite-convert` WP CLI command.

As always, be sure to test the migration and deployment in `development` or `staging` environments before rolling out to production.

0 comments on commit 97dbd77

Please sign in to comment.