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

First pass at install instructions for Site Template. #2248

Merged
merged 1 commit into from
Jul 25, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
42 changes: 42 additions & 0 deletions docs/installation/site-template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# ISLE Site Template

## What is the ISLE Site Template?

The [ISLE Site Template][ISLE Site Template] is a system for installing
Islandora on Docker. As with ISLE-DC, it uses [Docker Compose][Docker Compose]
to orchestrate the installation of all the different services (Docker
containers) that make up Islandora. Unlike ISLE-DC, in ISLE Site Template you
use Docker Compose commands directly, helping you to get familiar with the
kinds of commands that will be a key part of running and maintaining Islandora.

## Usage

1. **Do not clone the Isle Site Template!**
* Unlike most other repositories we provide, the Isle Site Template is not
meant to be cloned or forked. Rather, it can be downloaded using `curl`
and installed either manually or automatically.

2. Instead, follow the instructions in the ISLE Site Template's `README.md` and
`README.template.md` files.

* Instructions are provided both for `dev` and `prod` environments, with
different services available on each.

3. During installation, you will install a copy of the [Islandora Starter
Site][Islandora Starter Site].
* Though, if you select the manual installation option, you can change that
out for a different base composer project. This will form the basis of
your Drupal site. If you don't have a custom version, we recommend using the
Islandora Starter Site (and it's installed automatically during the automatic
install).

4. Customizing your site can be persisted to your own repo.
* In the process of setting you the ISLE Site Template, you are encouraged
to create a custom Git repository for this project. When you do, you can
save your changes to several components of your own site, for example the site
name in Docker, which services you have running, and all changes made to your
entire Drupal site configuration.

[ISLE Site Template]: https://github.com/Islandora-Devops/isle-site-template
[Docker Compose]: https://docs.docker.com/compose/
[Islandora Starter Site]: https://github.com/Islandora-Devops/islandora-starter-site
3 changes: 2 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ nav:
- '8.x-2.0 Release Notes': 'release_notes/8.x-2.0.md'
- 'Older Release Notes': 'https://github.com/Islandora/documentation/tree/main/docs/release_notes'
- 'Install a Demo': 'installation/install-a-demo.md'
- 'Docker (ISLE)':
- 'ISLE-DC':
- 'Introduction to ISLE': 'installation/docker-introduction.md'
- 'Prerequisites': 'installation/docker-prereq.md'
- Install Islandora:
Expand All @@ -98,6 +98,7 @@ nav:
- 'Available Commands': 'installation/docker-available-commands.md'
- 'Available Configuration': 'installation/docker-available-configuration.md'
- 'Troubleshooting' : 'installation/docker-troubleshooting.md'
- 'ISLE Site Template': 'installation/site-template.md'
- 'Ansible Playbook': 'installation/playbook.md'
- Manual Installation:
- 'Introduction': 'installation/manual/introduction.md'
Expand Down