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

updated layout of docker installation pages in preparation for site template docs #2306

Merged
merged 3 commits into from
May 30, 2024
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
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,4 @@ ISLE's architecture using [Docker](https://www.docker.com/) separates out the "s

ISLE is a suite of Docker containers that run the various components of Islandora: drupal, fedora, solr, alpaca, crayfish, matomo, etc. The individual containers are created (and automatically pushed to [Docker Hub](https://hub.docker.com/u/islandora)) by [ISLE BuildKit](https://github.com/Islandora-Devops/isle-buildkit).

In order to deploy the containers, however, you need to use a container orchestration tool. The ISLE project provides tools for running and maintaining the containers using docker-compose with [ISLE Docker Compose](https://github.com/Islandora-Devops/isle-dc).
In order to deploy the containers, however, you need to use a container orchestration tool. The ISLE project provides tools for running and maintaining the containers using docker-compose with [ISLE Docker Compose](https://github.com/Islandora-Devops/isle-dc) or [ISLE Site Template](https://github.com/Islandora-Devops/isle-site-template).
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ Docker Compose is a tool to simplify the process of running multiple Docker cont

### GNU Make

Make allows us to define commands that simplify installing and maintaining our Islandora site. For a complete list of available commands see the Makefile included with ISLE.
Make allows us to define commands that simplify installing and maintaining our Islandora site. For a complete list of available commands see the Makefile included with ISLE-DC.

### Composer

Expand All @@ -58,7 +58,6 @@ Drush is a command line tool for managing your Drupal site. It comes installed i
- Docker Compose version 2.x+
- GNU Make 4.0+
- Git 2.0+
- [ISLE Docker Compose](https://github.com/islandora-devops/isle-dc)
- At least 8GB of RAM (ideally 16GB)
- An administrator account your machine (a.k.a. the host machine)
- (Mac OS) Apple Developer Tools
Expand Down Expand Up @@ -89,11 +88,3 @@ If you need to install Docker, we recommend using the application [Docker Deskto
- Production or production-like development: 16GB

**Swap**: Swap space is space borrowed from your hard disk drive to serve as makeshift RAM as needed. If you cannot provide as much RAM as you would like, increase this as is reasonable given your free disk space.

## Installing ISLE Docker Compose

Use Git to install the ISLE Docker Compose tool:

`git clone https://github.com/islandora-devops/isle-dc`

Tagged versions are available [here](https://github.com/Islandora-Devops/isle-dc/tags).
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,14 @@ When developing locally, your Drupal site resides in your `isle-dc/codebase` fol
Drupal container. This lets you update code using the IDE of your choice on your host machine, and the
changes are automatically reflected on the Drupal container.

## Installing ISLE Docker Compose

Use Git to install the ISLE Docker Compose tool:

`git clone https://github.com/islandora-devops/isle-dc`

Tagged versions are available [here](https://github.com/Islandora-Devops/isle-dc/tags).

## Getting Started

If you don't already have a Drupal site, you'll be given a basic setup using Drupal 9 and the
Expand Down
2 changes: 1 addition & 1 deletion docs/user-documentation/users.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Additional user roles can be created and assigned customized permissions, as des
## Before you start

- This How-To assumes a very basic familiarity with Drupal.
- This How-To is generally applicable for any Islandora site, but the examples given are taken from an Islandora demo using the (optional) **[Islandora Starter Site](https://github.com/Islandora/islandora-starter-site)** configuration. This configuration is deployed automatically if you build your Islandora site with the appropriate options, using the [Ansible Playbook](../installation/playbook.md), [ISLE with Docker-Compose](../installation/docker-introduction.md).
- This How-To is generally applicable for any Islandora site, but the examples given are taken from an Islandora demo using the (optional) **[Islandora Starter Site](https://github.com/Islandora/islandora-starter-site)** configuration. This configuration is deployed automatically if you build your Islandora site with the appropriate options, using the [Ansible Playbook](../installation/playbook.md), [ISLE with Docker-Compose](../installation/docker/docker-introduction.md).

!!! islandora "Warning"
If you are writing to Fedora, your username must not contain spaces.
Expand Down
42 changes: 28 additions & 14 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,16 @@ plugins:
'contributing/docs_style_guide.md': 'contributing/docs-style-guide.md'
'contributing/readme_template.md': 'contributing/readme-template.md'
'installation/component_overview.md': 'installation/component-overview.md'
'installation/docker-available-commands.md': 'installation/docker/isle-dc/docker-available-commands.md'
'installation/docker-available-configuration.md': 'installation/docker/isle-dc/docker-available-configuration.md'
'installation/docker-basic-usage.md': 'installation/docker/isle-dc/docker-basic-usage.md'
'installation/docker-custom.md': 'installation/docker/isle-dc/docker-custom.md'
'installation/docker-introduction.md': 'installation/docker/docker-introduction.md'
'installation/docker-local.md': 'installation/docker/isle-dc/docker-local.md'
'installation/docker-maintain-drupal.md': 'installation/docker/isle-dc/docker-maintain-drupal.md'
'installation/docker-maintain-isle.md': 'installation/docker/isle-dc/docker-maintain-isle.md'
'installation/docker-prereq.md': 'installation/docker/docker-prereq.md'
'installation/docker-troubleshooting.md': 'installation/docker/isle-dc/docker-troubleshooting.md'
'installation/manual/configuring_drupal.md': 'installation/manual/configuring-drupal.md'
'installation/manual/installing_composer_drush_and_drupal.md': 'installation/manual/installing-composer-drush-and-drupal.md'
'installation/manual/installing_crayfish.md': 'installation/manual/installing-crayfish.md'
Expand All @@ -54,6 +64,7 @@ plugins:
'installation/manual/installing_solr.md': 'installation/manual/installing-solr.md'
'installation/manual/installing_tomcat_and_cantaloupe.md': 'installation/manual/installing-tomcat-and-cantaloupe.md'
'installation/manual/preparing_a_webserver.md': 'installation/manual/preparing-a-webserver.md'
'installation/site-template.md': 'installation/docker/site-template/site-template.md'
'technical-documentation/adding_format_jsonld.md': 'technical-documentation/adding-format-jsonld.md'
'technical-documentation/alpaca_tips.md': 'technical-documentation/alpaca-tips.md'
'technical-documentation/resizing_vm.md': 'technical-documentation/resizing-vm.md'
Expand All @@ -66,6 +77,7 @@ plugins:
'user-documentation/linked_data.md': 'user-documentation/linked-data.md'
'user-documentation/metadata_harvesting.md': 'user-documentation/metadata-harvesting.md'
'user-documentation/recipes/alexa_search.md': 'user-documentation/recipes/alexa-search.md'


extra:
font:
Expand Down Expand Up @@ -111,20 +123,22 @@ 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'
- 'ISLE-DC':
- 'Introduction to ISLE': 'installation/docker-introduction.md'
- 'Prerequisites': 'installation/docker-prereq.md'
- Install Islandora:
- 'Installing a Development Server': 'installation/docker-local.md'
- 'Installing a Staging/Production Server': 'installation/docker-custom.md'
- Maintaining Islandora:
- 'Basic Usage': 'installation/docker-basic-usage.md'
- 'Maintaining Drupal': 'installation/docker-maintain-drupal.md'
- 'Maintaining ISLE': 'installation/docker-maintain-isle.md'
- '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'
- 'Docker':
- 'Introduction to ISLE': 'installation/docker/docker-introduction.md'
- 'Prerequisites': 'installation/docker/docker-prereq.md'
- 'ISLE-DC':
- Installing:
- 'Installing a Development Server': 'installation/docker/isle-dc/docker-local.md'
- 'Installing a Staging/Production Server': 'installation/docker/isle-dc/docker-custom.md'
- Maintaining:
- 'Basic Usage': 'installation/docker/isle-dc/docker-basic-usage.md'
- 'Maintaining Drupal': 'installation/docker/isle-dc/docker-maintain-drupal.md'
- 'Maintaining ISLE': 'installation/docker/isle-dc/docker-maintain-isle.md'
- 'Available Commands': 'installation/docker/isle-dc/docker-available-commands.md'
- 'Available Configuration': 'installation/docker/isle-dc/docker-available-configuration.md'
- 'Troubleshooting' : 'installation/docker/isle-dc/docker-troubleshooting.md'
- 'ISLE Site Template':
- 'Introduction to Site Template': 'installation/docker/site-template/site-template.md'
- 'Ansible Playbook': 'installation/playbook.md'
- Manual Installation:
- 'Introduction': 'installation/manual/introduction.md'
Expand Down
Loading