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

Jump to bottom

Documentation updates for upcoming R202409 release #1322

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Documentation updates for upcoming R202409 release #1322

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c9684f1
Update INSTALL with latest known-good configs
cpeel Sep 9, 2024
041573c
Update CHANGELOG and UPGRADE for R202409 release
cpeel Aug 24, 2024
c3274b0
fixup! Update CHANGELOG and UPGRADE for R202409 release
cpeel Sep 13, 2024
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: 12 additions & 2 deletions SETUP/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,23 @@ see the git history.
[R202009](https://github.com/DistributedProofreaders/dproofreaders/releases/tag/R202009)
first before upgrading to R202102 or later releases.**

## R??????
## R202409
Scripts supporting this upgrade are in `SETUP/upgrade/21`

**This is the last release to support PHP 7.4. Future releases will only
support PHP 8.0 and later.**
support PHP 8.1 and later.**
Copy link
Member Author

Choose a reason for hiding this comment

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

Rationale behind this:

  • PHP 8.0 is already out of support.
  • PHP 8.1 is in Ubuntu 22.04 which is still supported. It also includes some useful type features. We tested with PHP 8.1 on the clone system earlier this year and know it works.
  • PHP 8.3 is what will be running on PROD after the upgrade later this year.


* Updated minimum middleware to MySQL 8.0 (cpeel)
* The deprecated globals mentioned in the last release notes were removed (cpeel)
* Most `faq/*` content has been deleted (cpeel)
* A `metadata.json` file has replaced `dc.xml` in the project directory (cpeel)
* New API endpoints for proofreading (70ray)
* Cronjobs now run through common interface with SA UI to show job status (cpeel)
* Typing added to numerous functions and classes (bpfoley, jchaffraix)
* XML feed types removed and feed backend improved (mrducky4)
* Navigation bar updates for smaller screens (cpeel)
* New site search page (cpeel)
* `past_tallies` is now a sparse table (cpeel)
Copy link
Member

@srjfoo srjfoo Sep 9, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

Should the new revised mentor page be included?

Copy link
Member Author

Choose a reason for hiding this comment

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

I don't think so, it's a pretty minor change for a pretty small subset of users.


## R202403
Scripts supporting this upgrade are in `SETUP/upgrade/20`
Expand Down
4 changes: 3 additions & 1 deletion SETUP/INSTALL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ components.

### PHP
PHP version 7.4 is the minimum supported version. Limited testing has been done
on PHP 8.0 and 8.1.
on PHP 8.1 and 8.3.

The following PHP extensions are required. They are listed below with their
Ubuntu system package names.
Expand Down Expand Up @@ -78,6 +78,8 @@ Any web server that supports PHP should work, although all testing has
been done using Apache 2. All known deployments, including pgdp.net,
are using Apache 2 as well.

The code will function with Apache's `mod_php` as well as `php-fpm`.

See `apache2.conf.example` for an example Apache config file, including
examples on enabling page compression and caching.

Expand Down
11 changes: 11 additions & 0 deletions SETUP/UPGRADE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,6 +117,7 @@ Run the scripts in the following directories in order
* c/SETUP/upgrade/18/
* c/SETUP/upgrade/19/
* c/SETUP/upgrade/20/
* c/SETUP/upgrade/21/

### Upgrading from release R202102
Run the scripts in the following directories in order
Expand All @@ -126,6 +127,7 @@ Run the scripts in the following directories in order
* c/SETUP/upgrade/18/
* c/SETUP/upgrade/19/
* c/SETUP/upgrade/20/
* c/SETUP/upgrade/21/

### Upgrading from release R202109
Run the scripts in the following directories in order
Expand All @@ -134,24 +136,33 @@ Run the scripts in the following directories in order
* c/SETUP/upgrade/18/
* c/SETUP/upgrade/19/
* c/SETUP/upgrade/20/
* c/SETUP/upgrade/21/

### Upgrading from release R202202
Run the scripts in the following directories in order

* c/SETUP/upgrade/18/
* c/SETUP/upgrade/19/
* c/SETUP/upgrade/20/
* c/SETUP/upgrade/21/

### Upgrading from release R202209 or R202303
Run the scripts in the following directories in order

* c/SETUP/upgrade/19/
* c/SETUP/upgrade/20/
* c/SETUP/upgrade/21/

### Upgrading from release R202309
Run the scripts in the following directories in order

* c/SETUP/upgrade/20/
* c/SETUP/upgrade/21/

### Upgrading from release R202403
Run the scripts in the following directories in order

* c/SETUP/upgrade/21/

## Install the modified `dp.cron`
Install the modified `dp.cron`.
Expand Down