Skip to content

Commit

Permalink
Issue #3069987 by daniel.bosen, mtodor: Update documentation
Browse files Browse the repository at this point in the history
* Link to centralized documentation

* Keep file in sync with thunder/thunder-project
  • Loading branch information
dbosen authored Aug 8, 2019
1 parent 7d543bc commit 0f7c612
Showing 1 changed file with 5 additions and 38 deletions.
43 changes: 5 additions & 38 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,35 +2,11 @@

This project template should provide a kickstart for managing your site dependencies with [Composer](https://getcomposer.org/).

If you want to know how to use it as replacement for
[Drush Make](https://github.com/drush-ops/drush/blob/8.x/docs/make.md) visit
the [Documentation on drupal.org](https://www.drupal.org/node/2471553).

## Usage

First you need to install [Composer](https://getcomposer.org/doc/00-intro.md#installation-linux-unix-osx) and [Git](https://git-scm.com).

> Note: The instructions below refer to the [global composer installation](https://getcomposer.org/doc/00-intro.md#globally).
You might need to replace `composer` with `php composer.phar` (or similar)
for your setup.
See our [install documentation](https://thunder.github.io/thunder-documentation/quick-install) on how to use Thunder project.

After that you can create the project:

```
composer create-project burdamagazinorg/thunder-project thunder
```

With `composer require ...` you can download new dependencies to your
installation.

```
cd thunder
composer require drupal/devel:1.*
```

The `composer create-project` command passes ownership of all files to the
project that is created. You should create a new git repository, and commit
all files not excluded by the .gitignore file.
We also have documentation on [extending](https://thunder.github.io/thunder-documentation/extending) and [updating](https://thunder.github.io/thunder-documentation/updating) Thunder sites.

## What does the template do?

Expand All @@ -47,15 +23,6 @@ When installing the given `composer.json` some tasks are taken care of:
* Latest version of drush is installed locally for use at `bin/drush`.
* Latest version of DrupalConsole is installed locally for use at `bin/drupal`.

## Installing Thunder

Create project will install Thunder into the docroot directory. You can now install Thunder as you would with any Drupal 8 site. See: [Drupal installation guide](https://www.drupal.org/node/1839310).

## Updating Thunder

To update Thunder, Drupal or any module to the newest version, constrained by the specified version in `composer.json`, execute `composer update`. This command will check every dependency for a new version, downloads it and updates the `composer.lock` accordingly.
After that you can run `drush updb` in the docroot folder to update the database of your site.

### File update

This project will attempt to keep all of your Thunder and drupal core files up-to-date; the
Expand All @@ -67,11 +34,11 @@ new release of Drupal core.

Follow the steps below to update your thunder files.

1. Run `composer update burdamagazinorg/thunder`
1. Run `composer update`
1. Run `git diff` to determine if any of the scaffolding files have changed.
Review the files for any changes and restore any customizations to
`.htaccess` or `robots.txt`.
1. Commit everything all together in a single commit, so `web` will remain in
1. Commit everything all together in a single commit, so `docroot` will remain in
sync with the `core` when checking out branches or running `git bisect`.
1. In the event that there are non-trivial conflicts in step 2, you may wish
to perform these steps on a branch, and use `git merge` to combine the
Expand Down Expand Up @@ -125,7 +92,7 @@ achieve that by registering `@drupal-scaffold` as post-install and post-update c
]
},
```
### How can I prevent downloading modules from thunder, that I do not need?
### How can I prevent downloading modules from Thunder, that I do not need?

To prevent downloading a module, that Thunder provides but that you do not need, add a replace block to your composer.json:

Expand Down

0 comments on commit 0f7c612

Please sign in to comment.