Updating ISLE docs #1797

dannylamb · 2021-04-12T18:29:54Z

Purpose / why

More accurate install docs, plus actual instructions for upgrading/updating.

What changes were made?

Filled in the gaps on https://islandora.github.io/documentation/installation/docker-compose/ and then some.

Verification

Please try as much of this stuff as you can.

Interested Parties

@Islandora/8-x-committers @Islandora/documentation

Checklist

Pull-request reviewer should ensure the following

Does this PR link to related issues?
Does the proposed documentation align with the Islandora Documentation Style Guide?
Are the changes accurate, useful, free of typos, etc?
Does this PR update the last updated on date on the documentation page?

Person merging should ensure the following

Does mkdocs still build successfully? (This is indicated by TravisCI passing. To test locally, and see warnings, see How To Build Documentation.)
If pages are renamed or removed, have all internal links to those pages been fixed?
If pages are added, have they been linked to or placed in the menu?
Did the PR receive at least one approval from a committer, and all issues raised have been addressed?

bseeger · 2021-04-14T17:17:58Z

docs/installation/docker-compose.md

+
+### Config Import
+
+`make config-import` will export import site's configuration from your site's config sync directory.


will export import site's should probably say will import site's

Should this also point out where the config/sync directory is? namely, it's in config/sync in your drupal's www folder - describing roughly where that location is.

bseeger · 2021-04-14T17:19:37Z

docs/installation/docker-compose.md

+
+- Used `make demo`
+- Are using a custom Drupal image
+- Don't want to bother with setting up a development environmen right now


type on word environmen

dannylamb · 2021-04-14T18:39:36Z

Thanks for the feedback @bseeger ! Done!

docs/installation/docker-compose.md

rosiel · 2021-04-16T18:28:54Z

docs/installation/docker-compose.md

 ```

+If you do not provide a `codebase` folder before running `make local`, you will be given a vanilla Drupal 9 installation with the `islandora` module enabled and only the iminimal configuration required to run.  It's not for the faint of heart, but if you want to avoid using `islandora_defaults`, you can build up your entire repository this way.


typo, minimal.

Also, it appears the expected workflow for anyone doing "real site building" (not just kicking the tyres) starting out is to "already have a site" and I'm confused at the catch-22 here.

What would the recommendation be for a group just starting with Islandora for a production environment? As @rosiel eluded to this is confusing.

For example, we are looking to start using Islandora, but want a starting point that we can customize but not be a full blown demo site with non affiliated data. Thanks!

misilot · 2021-04-22T14:26:02Z

docs/installation/docker-compose.md


-If you used `make local` then the drupal root folder is in a new directory in the isle-dc folder named `codebase`. This is live and editable in whatever development environment you would like.  If you just did `make demo`, you will need to spin down your containers with `-v` to destroy your state before starting a new one with `make local`.
+Use `docker-compose up -d` to bring a site back up. You should _not_ run `make local` or `make demo` again unless you used `-v` when shutting down the site.


So, make local and make demo should only ever be run once, unless you delete the volumes, and if changes are made to any of the docker-compose files, we should only be using the make -B docker-compose.yml command, correct?

misilot · 2021-04-22T14:38:28Z

Could recommendations for deployment for a Production environment be added? For example the following topics

Configuring the SSL certificate or be able to utilize Let's Encrypt / or specify another ACME provider?
Steps on how to utilize the make local for development environment, with steps to create our own containers that can be deployed in production
DISABLE_SYN I can't find what this is used for, but it is in the .env file.
ENVIRONMENT what are the valid options for this variable
Recommendations for what should be disabled. Should we be editing the different docker-compose files or some other method? For example there are comments of "Do not expose in production." in the different files. Just trying to understand what I should be commenting our and where.

Thanks for working on this! It was very easy to stand up, just want to make sure I am doing it correctly.

misilot · 2021-04-22T14:44:26Z

docs/installation/docker-compose.md

+- Set `INCLUDE_CODE_SERVER_SERVICE=true` in your `.env` file
+- make -B docker-compose.yml
+- docker-compose up -d  
+


Is it possible to use code server with a make local install and codebase directory?

…into isle-dcs

dannylamb · 2021-06-24T19:14:24Z

I have completely rewritten massive chunks of this, restructured and re-organized them, and tried to address all the feedback I was given.

I know it's a lot, but if anyone has a chance to give this a look and give me any more feedback, I'd super appreciate it.

mjordan · 2021-06-24T20:55:49Z

@dannylamb as a relative newby to ISLE and someone who has struggled a bit getting to understand it, I would be happy to review these docs.

mjordan

I don't see any documentation on how to not run a particular container. For example, if I don't want to run blazegraph, how would I configure .env (or whatever) to tell Docker to just skip deploying that container?

docs/installation/docker-available-configuration.md

docs/installation/docker-prereq.md

rosiel · 2021-07-20T13:41:24Z

@mjordan have your changes requested been met?

mjordan · 2021-07-20T14:43:21Z

@rosiel yes

bondjimbond · 2021-07-23T15:43:43Z

@mjordan it's still showing "changes requested"; is there a way for you to mark them as resolved?

Otherwise, is this good to go?

mjordan · 2021-07-23T15:47:51Z

Sorry, changes accepted.

bondjimbond · 2021-07-23T15:50:17Z

Cool. So who gets to hit the merge button?

mjordan · 2021-07-23T15:51:10Z

Since I was the holdout, I'll do it.

Updating ISLE docs

48c2162

dannylamb mentioned this pull request Apr 12, 2021

Which branch does it work for islandora with docker? Islandora-Devops/isle-dc#152

Open

bseeger reviewed Apr 14, 2021

View reviewed changes

Update docker-compose.md

8113739

rosiel reviewed Apr 16, 2021

View reviewed changes

misilot reviewed Apr 22, 2021

View reviewed changes

dannylamb added 13 commits June 18, 2021 15:26

Trying to break things apart

35f5d21

Merge branch 'isle-dcs' of https://github.com/Islandora/documentation …

066ca45

…into isle-dcs

Delete docker-custom

7b89379

Update docker-custom.md

35bccee

Custom instructions

930fb3b

Merging in upstream changes

c37befb

maintenance docs

673bd5d

Putting available commands back in

af1d306

Adding all available configuration options

5c36fbc

Adding basic usage page

e633cc2

More clarity on deploying a production site

9f9ae73

troubleshooting information

2a29bc3

cleaning up the old isle docs

0c11d34

mjordan self-requested a review June 24, 2021 20:56

mjordan requested changes Jun 30, 2021

View reviewed changes

docs/installation/docker-available-configuration.md Show resolved Hide resolved

docs/installation/docker-prereq.md Outdated Show resolved Hide resolved

docs/installation/docker-prereq.md Show resolved Hide resolved

dannylamb added 2 commits July 15, 2021 11:16

Update docker-available-configuration.md

fc14cd8

Update docker-prereq.md

a553f20

mjordan approved these changes Jul 23, 2021

View reviewed changes

mjordan merged commit a17721d into main Jul 23, 2021

rosiel deleted the isle-dcs branch August 30, 2021 14:39

ysuarez mentioned this pull request Dec 5, 2021

Recreating the intention of PR #1816 explaining "make not found error" #1995

Merged

8 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Updating ISLE docs #1797

Updating ISLE docs #1797

dannylamb commented Apr 12, 2021

bseeger Apr 14, 2021 •

edited

Loading

bseeger Apr 14, 2021

dannylamb commented Apr 14, 2021

rosiel Apr 16, 2021

misilot Apr 22, 2021

misilot Apr 22, 2021

misilot commented Apr 22, 2021

misilot Apr 22, 2021

dannylamb commented Jun 24, 2021

mjordan commented Jun 24, 2021

mjordan left a comment

rosiel commented Jul 20, 2021

mjordan commented Jul 20, 2021

bondjimbond commented Jul 23, 2021

mjordan commented Jul 23, 2021

bondjimbond commented Jul 23, 2021

mjordan commented Jul 23, 2021


		### Config Import

		`make config-import` will export import site's configuration from your site's config sync directory.

		```

		If you do not provide a `codebase` folder before running `make local`, you will be given a vanilla Drupal 9 installation with the `islandora` module enabled and only the iminimal configuration required to run. It's not for the faint of heart, but if you want to avoid using `islandora_defaults`, you can build up your entire repository this way.


		If you used `make local` then the drupal root folder is in a new directory in the isle-dc folder named `codebase`. This is live and editable in whatever development environment you would like. If you just did `make demo`, you will need to spin down your containers with `-v` to destroy your state before starting a new one with `make local`.
		Use `docker-compose up -d` to bring a site back up. You should _not_ run `make local` or `make demo` again unless you used `-v` when shutting down the site.

Updating ISLE docs #1797

Updating ISLE docs #1797

Conversation

dannylamb commented Apr 12, 2021

Purpose / why

What changes were made?

Verification

Interested Parties

Checklist

bseeger Apr 14, 2021 • edited Loading

Choose a reason for hiding this comment

bseeger Apr 14, 2021

Choose a reason for hiding this comment

dannylamb commented Apr 14, 2021

rosiel Apr 16, 2021

Choose a reason for hiding this comment

misilot Apr 22, 2021

Choose a reason for hiding this comment

misilot Apr 22, 2021

Choose a reason for hiding this comment

misilot commented Apr 22, 2021

misilot Apr 22, 2021

Choose a reason for hiding this comment

dannylamb commented Jun 24, 2021

mjordan commented Jun 24, 2021

mjordan left a comment

Choose a reason for hiding this comment

rosiel commented Jul 20, 2021

mjordan commented Jul 20, 2021

bondjimbond commented Jul 23, 2021

mjordan commented Jul 23, 2021

bondjimbond commented Jul 23, 2021

mjordan commented Jul 23, 2021

bseeger Apr 14, 2021 •

edited

Loading