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

Updating readme for D10/D11 + php 8.1+ #205

Open
wants to merge 1 commit into
base: 8.x
Choose a base branch
from
Open

Updating readme for D10/D11 + php 8.1+ #205

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 8 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# Search API Pantheon: Solr 8 & Drupal 9/10 Integration
# Search API Pantheon: Solr 8 & Drupal 10/11 Integration

[![Search API Pantheon](https://github.com/pantheon-systems/search_api_pantheon/actions/workflows/ci.yml/badge.svg?branch=8.x)](https://github.com/pantheon-systems/search_api_pantheon/actions/workflows/ci.yml)
[![Limited Availability](https://img.shields.io/badge/Pantheon-Limited_Availability-yellow?logo=pantheon&color=FFDC28)](https://pantheon.io/docs/oss-support-levels#limited-availability)

## Important Notice - Schema Reversion Prevention

Starting with version 8.2, this module includes critical fixes to prevent Solr schema reversions that could cause:
Starting with version 8.3, this module includes critical fixes to prevent Solr schema reversions that could cause:
Copy link
Member

Choose a reason for hiding this comment

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

This started with 8.2 shouldn't need to change.

Suggested change
Starting with version 8.3, this module includes critical fixes to prevent Solr schema reversions that could cause:
Starting with version 8.2, this module includes critical fixes to prevent Solr schema reversions that could cause:


- Search functionality outages
- Loss of indexed content
Expand All @@ -18,14 +18,16 @@ Users experiencing these issues should upgrade immediately to version 8.1.x-dev.

This module is for you if you meet the following requirements:

- Using Drupal 9.4/10
- Using Drupal 10/11
- PHP 8.1 or later
- Hosting the Drupal site on Pantheon's platform
- Your site uses `composer` to install modules and upgrade Drupal core using one of the following integrations:

- Pantheon's integrated composer (`build step: true` in your pantheon.yml)
- A Continuous Integration service like Circle CI or Travis

- Have Dashboard access to the platform (necessary to deploy code changes)
- Have Solr enabled on your Pantheon site

## Intent

Expand Down Expand Up @@ -55,15 +57,15 @@ Composer is the way you should be managing your drupal module requirements. This
To install this module via composer, run the following command in your Drupal root:

```bash
composer require 'drupal/search_api_pantheon:^8.1'
composer require 'drupal/search_api_pantheon:^8.3'
```

### Development Version

Note that the above will install the latest stable release of this module. To install the latest development version, use:

```bash
composer require 'drupal/search_api_pantheon:8.1.x-dev@dev'
composer require 'drupal/search_api_pantheon:8.x-dev@dev'
```

## Setup
Expand Down Expand Up @@ -100,7 +102,7 @@ To configure the connection with Pantheon, perform the following steps on your D

#### Automatic Core Reload

Starting with version 8.1.x, Search API Pantheon automatically reloads the Solr core after schema updates to prevent schema reversions and maintain index integrity.
Starting with version 8.3.x, Search API Pantheon automatically reloads the Solr core after schema updates to prevent schema reversions and maintain index integrity.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
Starting with version 8.3.x, Search API Pantheon automatically reloads the Solr core after schema updates to prevent schema reversions and maintain index integrity.
Starting with version 8.2.0, Search API Pantheon automatically reloads the Solr core after schema updates to prevent schema reversions and maintain index integrity.


#### Schema Updates

Expand Down