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.

Sign up for GitHub

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

Fixes some references to Drupal 8 #633

Merged
merged 2 commits into from
Dec 2, 2021
Merged

Fixes some references to Drupal 8 #633

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ab69965
Fixes some references to Drupal 8
earth2marsh Oct 19, 2021
a4a1ddd
Merge branch '2.x' into earth2marsh-patch-1
raakesh-blokhra Dec 1, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Apigee Edge Drupal module

The Apigee Edge module enables you to integrate Drupal 9 or Drupal 8 with Apigee:
The Apigee Edge module enables you to integrate Drupal 9 with Apigee.

* Users that register or are added to the Drupal site will be added as developers in Apigee.
* Click on "Apps" in user menu to get keys for the APIs exposed in Apigee.
Expand All @@ -10,7 +10,7 @@ This module includes the following submodules:
* __Debug:__ enables administrators to configure and manage Apigee debug logs.
* __Teams:__ enables developers to be organized into teams.

For more details read the [Apigee Edge module documentation](https://www.drupal.org/docs/8/modules/apigee-edge).
For more details read the [Apigee Edge module documentation](https://www.drupal.org/docs/contributed-modules/apigee-edge).

## Support for Apigee Hybrid Cloud: Beta Release

Expand All @@ -20,8 +20,8 @@ Please note that Team APIs and Monetization APIs are not currently supported on

## Requirements

* The Apigee Edge module requires **Drupal 8.7.x** or higher and PHP 7.1 or higher.
* Drupal 8's minimum requirement is phpdocumentor/reflection-docblock:2.0.4 but at least 3.0 is required by this module. If you get the error "Your requirements could not be resolved to an installable set of packages" it may be because you are running reflection-docblock version 2. You can update `phpdocumentor/reflection-docblock` with the following command: `composer update phpdocumentor/reflection-docblock --with-dependencies`.
* The Apigee Edge module requires **Drupal 8.7.x** or higher and PHP 7.1 or higher, though Drupal 9.x is recommended due to [Drupal 8's EOL timeline](https://www.drupal.org/psa-2021-2021-06-29).
* Drupal's minimum requirement is phpdocumentor/reflection-docblock:2.0.4 but at least 3.0 is required by this module. If you get the error "Your requirements could not be resolved to an installable set of packages" it may be because you are running reflection-docblock version 2. You can update `phpdocumentor/reflection-docblock` with the following command: `composer update phpdocumentor/reflection-docblock --with-dependencies`.
* **Check [composer.json](https://github.com/apigee/apigee-edge-drupal/blob/8.x-1.x/composer.json) for any required patches.** Patches prefixed with "(For testing)" are only required for running tests. Those are not necessary for using this module. Patches can be applied with the [cweagans/composer-patches](https://packagist.org/packages/cweagans/composer-patches) plugin automatically or manually. See [Applying Patches](#applying-patches) section below.
Copy link
Member

Choose a reason for hiding this comment

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

Can we update the reference to to the composer.json to https://github.com/apigee/apigee-edge-drupal/blob/2.x/composer.json

Copy link
Contributor

Choose a reason for hiding this comment

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

Actually, since the PHP API client dropped PHP 7.1/7.2 support therefore this module also has a minimum PHP 7.3 requirement ;)
https://github.com/apigee/apigee-client-php/releases/tag/2.0.11

Copy link
Contributor

Choose a reason for hiding this comment

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

And possibly it is a good idea to define and announce and Drupal < 9 end of support schedule for this module (family), unless we have the capacity to support an unsupported Drupal version and everything that comes with the latest and greatest.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Please go ahead and make any additional improvements. I'm not sure how to take action on the suggestions, so perhaps merge this PR and begin another?

* (For developers) The locked commit from `behat/mink` library is required otherwise tests may fail. This caused by a Drupal core [bug](https://www.drupal.org/project/drupal/issues/2956279). See the related pull request for behat/mink [here](https://github.com/minkphp/Mink/pull/760).

Expand All @@ -40,15 +40,15 @@ Please note that Team APIs and Monetization APIs are not currently supported on
2. Click **Extend** in the Drupal administration menu.
3. Select the **Apigee Edge** module.
4. Click **Install**.
5. Configure the [connection to your Apigee org](https://www.drupal.org/docs/8/modules/apigee-edge/configure-the-connection-to-apigee-edge)
5. Configure the [connection to your Apigee org](https://www.drupal.org/docs/contributed-modules/apigee-edge/configure-the-connection-to-apigee)

## Notes

* If you do not configure the connection between Drupal and Apigee, you will not be able to register developers on
the site and may cause other issues with Drupal core functions. If you do not plan to configure the connection between
Drupal and Apigee, you should uninstall the Apigee Edge module.
* When you first install the module, existing users in the Drupal site may not have a developer account in Apigee.
You can run [developer synchronization](https://www.drupal.org/docs/8/modules/apigee-edge/synchronize-developers-with-apigee-edge)
You can run [developer synchronization](https://www.drupal.org/docs/contributed-modules/apigee-edge/synchronize-developers-with-apigee-edge)
to make sure Drupal users and Apigee developers are synchronized.

## Applying Patches
Expand Down Expand Up @@ -80,4 +80,4 @@ Development is coordinated in our [GitHub repository](https://github.com/apigee/

## Support

This project, which integrates Drupal 9 & 8 with Apigee, is supported by Google.
This project, which integrates Drupal with Apigee, is supported by Google.