mirror of
https://github.com/silverstripe/silverstripe-subsites
synced 2024-10-22 11:05:55 +02:00
Merge pull request #484 from creative-commoners/pulls/2.5/standardise-modules
MNT Standardise modules
This commit is contained in:
Guy Sartorelli
GitHub
commit
0338d41626
2
.github/workflows/ci.yml
vendored
2
.github/workflows/ci.yml
vendored
@ -12,5 +12,5 @@ jobs:
|
||||
ci:
|
||||
name: CI
|
||||
# Only run cron on the silverstripe account
|
||||
if: (github.event_name == 'schedule' && startsWith(github.repository, 'silverstripe/')) || (github.event_name != 'schedule')
|
||||
if: (github.event_name == 'schedule' && github.repository_owner == 'silverstripe') || (github.event_name != 'schedule')
|
||||
uses: silverstripe/gha-ci/.github/workflows/ci.yml@v1
|
||||
|
||||
2
.github/workflows/keepalive.yml
vendored
2
.github/workflows/keepalive.yml
vendored
@ -10,7 +10,7 @@ jobs:
|
||||
keepalive:
|
||||
name: Keepalive
|
||||
# Only run cron on the silverstripe account
|
||||
if: (github.event_name == 'schedule' && startsWith(github.repository, 'silverstripe/')) || (github.event_name != 'schedule')
|
||||
if: (github.event_name == 'schedule' && github.repository_owner == 'silverstripe') || (github.event_name != 'schedule')
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Keepalive
|
||||
|
||||
@ -1,13 +0,0 @@
|
||||
inherit: true
|
||||
|
||||
checks:
|
||||
php: true
|
||||
|
||||
build:
|
||||
nodes:
|
||||
analysis:
|
||||
tests:
|
||||
override: [php-scrutinizer-run]
|
||||
|
||||
filter:
|
||||
paths: [src/*, tests/*]
|
||||
@ -1,8 +0,0 @@
|
||||
version: ~> 1.0
|
||||
|
||||
import:
|
||||
- silverstripe/silverstripe-travis-shared:config/provision/standard-jobs-range-behat.yml
|
||||
|
||||
env:
|
||||
global:
|
||||
- BEHAT_SUITE="@subsites"
|
||||
13
README.md
13
README.md
@ -1,9 +1,7 @@
|
||||
# Subsites Module
|
||||
|
||||
[](https://github.com/silverstripe/silverstripe-subsites/actions/workflows/ci.yml)
|
||||
[](https://scrutinizer-ci.com/g/silverstripe/silverstripe-subsites/?branch=master)
|
||||
[](https://codecov.io/gh/silverstripe/silverstripe-subsites)
|
||||
[](https://www.silverstripe.org/software/addons/silverstripe-commercially-supported-module-list/)
|
||||
[](https://www.silverstripe.org/software/addons/silverstripe-commercially-supported-module-list/)
|
||||
|
||||
## Introduction
|
||||
|
||||
@ -11,7 +9,7 @@ The subsites module provides a convenient way of running multiple websites from
|
||||
sharing users, content, and assets between them - the sites will be managed from a single CMS.
|
||||
|
||||
A useful way to think of its use is where you have a business with a global headquarters and four branches in various
|
||||
countries. The subsites module allows the five offices to use a single SilverStripe installation, and have information
|
||||
countries. The subsites module allows the five offices to use a single Silverstripe installation, and have information
|
||||
from the headquarters flow down into the branches. The branches can hold information that is individual and the website
|
||||
templates can also be different.
|
||||
|
||||
@ -61,7 +59,7 @@ If more isolation of code, security, or performance is needed, then consider run
|
||||
|
||||
## Requirements
|
||||
|
||||
* SilverStripe 4.x
|
||||
* Silverstripe 4.x
|
||||
|
||||
## Installation
|
||||
|
||||
@ -71,7 +69,7 @@ If more isolation of code, security, or performance is needed, then consider run
|
||||
* Once you've created a subsite, you'll see a "Create Subsite Domain" button, hit that button to enter a domain or subdomain for your subsite. This will determine the URL of your website. For example, if your site is running on `http://localhost/mysite`, and you set the subdomain to "subsite", then your subsite will be accessible on `http://subsite.localhost/mysite`
|
||||
* Go to the "Pages" section of the CMS. In the top-left above the menu, you'll see a dropdown listing the two subsites - "Main site" is the original site that you had before you installed the subsites module. Select your new subsite, and the site content tree will be changed. It should be empty at this stage.
|
||||
* Add a page - change its title to "Home", and its URL Segment will be changed to "home". Save the page.
|
||||
* Update your DNS and, if necessary, your webserver configuration, so that your subdomain will point to the SilverStripe installation on your webserver. Visit this new subdomain. You should see the new subsite homepage.
|
||||
* Update your DNS and, if necessary, your webserver configuration, so that your subdomain will point to the Silverstripe installation on your webserver. Visit this new subdomain. You should see the new subsite homepage.
|
||||
|
||||
## Usage
|
||||
|
||||
@ -110,7 +108,7 @@ theme in the dropdown. Now, this subsite will use a different theme from the ma
|
||||
|
||||
#### Cascading themes
|
||||
|
||||
In SilverStripe 4 themes will resolve theme files by looking through a list of themes (see the documentation on
|
||||
In Silverstripe 4 themes will resolve theme files by looking through a list of themes (see the documentation on
|
||||
[creating your own theme](https://docs.silverstripe.org/en/4/developer_guides/templates/themes/#developing-your-own-theme)).
|
||||
Subsites will inherit this configuration for the order of themes. Choosing a theme for a Subsite will set the list of
|
||||
themes to that chosen theme, and all themes that are defined below the chosen theme in priority. For example, with a
|
||||
@ -220,7 +218,6 @@ or by defining the subsiteCMSShowInMenu function in your admin:
|
||||
return true;
|
||||
}
|
||||
|
||||
|
||||
### Public display of a subsite
|
||||
|
||||
By default, each subsite is available to the public (= not logged-in),
|
||||
|
||||
@ -1,3 +1,4 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<phpunit bootstrap="vendor/silverstripe/cms/tests/bootstrap.php" colors="true">
|
||||
<testsuites>
|
||||
<testsuite name="Default">
|
||||
|
||||
Loading…
Reference in New Issue
Block a user