Skip to content

Commit

Permalink
Updated README file (#705)
Browse files Browse the repository at this point in the history
* ACMS-4134: Add mysql57 backport module to DRP.

* ACMS-4134: Update Readme for mysql57 instruction on Acquia Cloud.

* Modified instructions for memcache settings, installtion and upgrade

* Added missing full stop in README file

---------

Co-authored-by: rajeshreeputra <[email protected]>
  • Loading branch information
vipin-mittal-acquia and rajeshreeputra authored Nov 8, 2024
1 parent 012dcd1 commit a96fade
Show file tree
Hide file tree
Showing 3 changed files with 58 additions and 38 deletions.
49 changes: 12 additions & 37 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,63 +15,38 @@ This project includes the following packages and configurations:
* [Drush](https://github.com/drush-ops/drush) (Drupal CLI and development tool)
* [Asset Packagist](https://asset-packagist.org/) repository, package, and configuration
* [Acquia environment detection](https://github.com/acquia/drupal-environment-detector)
* [Acquia platform memcache settings](https://github.com/acquia/memcache-settings)
* [Acquia platform memcache settings](https://github.com/acquia/memcache-settings) (Not required on Acquia Cloud Next Platform)
* Best practices for Drupal development, testing and project architecture

The Acquia Drupal Starter kit allows you to install Drupal for a given style of CMS:

| Name | Description |
| ------------- | ------------- |
| Acquia Drupal Enterprise Low-code Starter kit | The low-code starter kit will install starter kit with Site Studio and a UIkit. It provides drag and drop content authoring and low-code site building. An optional content model can be added in the installation process. |
| Acquia Drupal Community Starter kit | The community starter kit will get installed. An optional content model can be added in the installation process. |
| Acquia Drupal Headless Starter kit | The headless starter kit preconfigures Drupal for serving structured, RESTful content to 3rd party content displays such as mobile apps, smart displays and frontend driven websites (e.g. React or Next.js). |

For more information on selecting the Acquia Drupal Starter kit that best fits your
use case follow
[instructions](https://docs.acquia.com/acquia-cms/install-cms).
## Acquia Drupal Starter Kits
To learn more about Acquia Drupal starter kits, please refer to the [documentation](https://docs.acquia.com/drupal-starter-kits/starter-kits).

## Installation

Create a new project using Composer:
Create a new Drupal 11 project using Composer:
```
composer create-project --no-interaction acquia/drupal-recommended-project
```

Once you create the project, you can and should customize `composer.json` and
the rest of the project to suit your needs. You will receive updates from any
dependent packages, but not from the project template itself. It's yours to
keep!

For instance, you can remove a provided package by running the following command
and committing the changed `composer.json` and `composer.lock` to Git:
```
composer remove acquia/mysql56
```
To install Drupal Starter Kit, follow the [instructions](https://docs.acquia.com/drupal-starter-kits/install-cms).

You should only commit changes to `composer.json` and `composer.lock`. Do not
commit files in the `vendor`, `docroot/core`, and similar directories (these are
ignored by the provided `.gitignore` file). In order to run your application
in another environment, you’ll need to run `composer install` to reinstall
these assets. [Acquia Code Studio’s](https://docs.acquia.com/code-studio/)
Auto DevOps feature can do this automatically when deploying to Acquia Cloud.

## Usage (Install Acquia Drupal Starter kit)
## Install other Drupal versions

Follow [instructions](https://docs.acquia.com/acquia-cms/using-split-commands).


## Other Drupal versions

Drupal 11 is installed by default. To install Drupal 10, use the below command:
To install Drupal 10 version, use the below command:
```
composer create-project acquia/drupal-recommended-project:^2
```
To install Drupal 9, use the below command:
To install Drupal 9 version, use the below command:
```
composer create-project acquia/drupal-recommended-project:^1
```

## Upgrading

To upgrade Acquia Drupal starter Kit, follow the [instructions](https://docs.acquia.com/drupal-starter-kits/upgrading-drupal-starter-kits-and-its-dependencies).

The Acquia Cloud Platform does not yet support MySQL 8.0, therefore enabling the backport database driver module is required for Drupal 11 installation on Acquia Cloud Platform. Follow [instructions](https://docs.acquia.com/acquia-cloud-platform/develop-apps/drupal-apps/mysql-80-57-backport-database-driver-upgrading).

# License

Expand Down
1 change: 1 addition & 0 deletions composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
"drupal/config_sync_without_site_uuid": "^1.0@beta",
"drupal/core-composer-scaffold": "^11",
"drupal/core-recommended": "^11",
"drupal/mysql57": "^1.0",
"drush/drush": "^13",
"oomphinc/composer-installers-extender": "^2"
},
Expand Down
46 changes: 45 additions & 1 deletion composer.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit a96fade

Please sign in to comment.