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

Adding documentation for setting up workspace on Drupal projects #281

Merged
merged 18 commits into from
Sep 21, 2020

Conversation

sawtell
Copy link
Contributor

@sawtell sawtell commented Apr 27, 2020

This PR adds documentation for the Drupal 8 harness.

The documentation covers:

  • Installing a new project, existing project and a multi-site project
  • Customising the Workspace environment with overrides and helper commands
  • Advanced customisation for adding services and using twig templates
  • Some information on how to contribute to the project. (This could be improved)

@sawtell sawtell added wip Good for newcomers do-not-merge labels Apr 27, 2020
@kierenevans
Copy link
Contributor

This is really amazing to see. Thank you!

In `workspace.yml` add:
```yaml
attribute('mysql.image'): quay.io/continuouspipe/mysql5.7
attribute('mysql.tag'): latest
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@kierenevans, I've left this as latest for now. Will the continouspipe image be updated or should I change this to either use stable or add the grants in the install steps?

Copy link
Contributor

Choose a reason for hiding this comment

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

Let's update to use the init step grants instead of the CP image

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sure - my concern with that approach is that they don't trigger once you have a DB dump in tools/assets. Probably not an issue for the initial install, but if someone destroys and re-installs then the databases won't be created.

Taking a look at other options, would it work if we created them in the before('harness.install') event?

Copy link
Contributor

Choose a reason for hiding this comment

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

I think it's triggered too early to use against a running container: https://github.com/my127/workspace/blob/0.1.x/src/Types/Workspace/Installer.php#L79

The ws enable command is called by the after.harness.install event triggered here:
https://github.com/my127/workspace/blob/0.1.x/src/Types/Workspace/Installer.php#L97
and received here:

after('harness.install'): |
#!bash
ws enable

Only then is the set of docker containers brought up.

After that we are left with either build step, install step, init step, or customising enable.sh to be able to do extra things in between.

Copy link
Contributor

@kierenevans kierenevans May 5, 2020

Choose a reason for hiding this comment

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

Sure - my concern with that approach is that they don't trigger once you have a DB dump in tools/assets.

I think that's why we did the grants as the init step rather than install step.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Updated to use the init steps.

@kierenevans kierenevans added this to the 0.7.0 milestone May 11, 2020
@kierenevans kierenevans added enhancement New feature or request harness-drupal8 Drupal 8.x harness, obsolete as of 1.5.x labels May 11, 2020
@kierenevans kierenevans changed the base branch from 0.6.x to 0.7.x May 12, 2020 14:09
@kierenevans kierenevans modified the milestones: 0.7.0, 0.8.0 May 27, 2020
└- tools/
. └- assets/
. . └- development/
. . . ├- drupal.sql.gz
Copy link
Contributor

Choose a reason for hiding this comment

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

Needs updated to one_site.sql.gz

@kierenevans kierenevans changed the base branch from 0.7.x to 0.8.x May 29, 2020 11:51
@kierenevans kierenevans modified the milestones: 0.8.0, 0.9.0 Jun 18, 2020
@kierenevans kierenevans changed the base branch from 0.8.x to 0.9.x June 19, 2020 07:19
@kierenevans kierenevans modified the milestones: 0.9.0, 0.10.0 Aug 7, 2020
@andytson-inviqa andytson-inviqa marked this pull request as draft August 11, 2020 19:58
@andytson-inviqa andytson-inviqa removed the wip Good for newcomers label Aug 11, 2020
@kierenevans kierenevans changed the base branch from 0.9.x to 0.10.x August 12, 2020 11:25
@sawtell sawtell marked this pull request as ready for review September 17, 2020 14:32
@kierenevans
Copy link
Contributor

@sawtell
Copy link
Contributor Author

sawtell commented Sep 21, 2020

Hi @kierenevans, I can't approve them, but they look great! Thanks for fixing the bugs and improved explanations. 👍

@kierenevans kierenevans merged commit 758b094 into 0.10.x Sep 21, 2020
@kierenevans kierenevans deleted the feature/drupal8-documentation branch September 21, 2020 12:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request harness-drupal8 Drupal 8.x harness, obsolete as of 1.5.x
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants