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 production install instructions #2225

Merged
merged 2 commits into from
May 24, 2023

Conversation

joshdentremont
Copy link
Contributor

Included new make commands and .env variables to allow for creating a site and connecting to a container registry.

Purpose / why

Production instructions have changed with the addition of make production and several new variables and make commands have been added to simplify the process of creating and pushing/pulling a custom Drupal image

What changes were made?

Instructions for creating a production site have been updated. Also added some clarification around the difference between a custom environment and a starter site, and how they relate to each other.

Verification

To test this you should create a new development and production site from the new instructions. Requires setting up a new git repository and container repository, but github and/or dockerhub should be fine for testing purposes.

Interested Parties

  • @Islandora/documentation
  • @Islandora/committers

Checklist

Pull-request Reviewer

Pull-request reviewer should ensure the following:

Person Merging

The 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?

Included new make commands and .env variables to allow for creating a site and connecting to a container registry.
Copy link
Contributor

@aOelschlager aOelschlager left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Everything looks good to me aside from the part that I had a question about. It's possible that I may have misread that part so I will I'll look at it again tomorrow with a fresh pair of eyes.

This way you can easily spin up a new site based on your modules and configuration, instead of the Islandora Starter Site. It will
also allow you to sync changes between your production, staging, and development sites.

You will likely want to include the Isle-dc directory as well as your codebase folder. This will allow you to make modifications to
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This part is confusing me a little bit. Is the codebase github repository separate from the isle-dc one or are you committing them into one repository?

Copy link
Contributor Author

@joshdentremont joshdentremont May 18, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've committed them together in one repo. I just changed the remote URL to point to my private repo instead of Isle-DC and then started making modifications. So my repo has the Isle-DC history up to the point where I started my site. I don't plan to pull any more changes from Isle-DC after that point, and instead will be making my own customizations, but you could continue to pull from Isle-DC if you wanted to.

I also changed the .gitignore to not ignore the entire codebase folder, but still ignore the web and vendor directories. This is basically the equivalent of combining Isle-DC and the starter site into one git repo, but will quickly diverge into my own set of modules, modifcations to the Makefile, etc.

Doing things this way lets me clone my whole project locally or in production and use the Isle-DC makefile to quickly spin up the site based on the composer.json file in my codebase directory. It's also helpful to have them together for CI/CD if you want to do things like building the image when you make changes to the codebase folder.

That wording was somewhat unclear, so I have taken another pass at that section. Hopefully it makes more sense now, but please let me know if it needs further clarification.

@aOelschlager
Copy link
Contributor

Great work! Thank you for clarifying this. That makes sense to me now. We will want to make note of the gitignore for the codebase folder in the isle-dc readme as well if it isn't already there now.

@aOelschlager aOelschlager merged commit 441fdc0 into Islandora:main May 24, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants