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.

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

Review of the Silverstripe CMS 5.2.0 changelog #482

Merged

Conversation

GuySartorelli
Copy link
Member

@GuySartorelli GuySartorelli commented Mar 18, 2024

Description

Review of the Silverstripe CMS 5.2.0 changelog.

Commits

  1. Update note about linkfield migration guides
  2. add new items to changelog
  3. overall review of content (writing style and readability)

New items added to the changelog

I found these in the commits list from the beta changelog. If you disagree with any of these being in the changelog let me know, there's only a couple here that I'm really adamant on and the rest I could take or leave.

Issues

Pull request checklist

  • The target branch is correct
  • All commits are relevant to the purpose of the PR (e.g. no TODO comments, unrelated rewording/restructuring, or arbitrary changes)
    • Small amounts of additional changes are usually okay, but if it makes it hard to concentrate on the relevant changes, ask for the unrelated changes to be reverted, and submitted as a separate PR.
  • The commit messages follow our commit message guidelines
  • The PR follows our contribution guidelines
  • The changes follow our writing style guide
  • Code examples follow our coding conventions
  • CI is green

@GuySartorelli GuySartorelli marked this pull request as draft March 18, 2024 03:03
@GuySartorelli GuySartorelli mentioned this pull request Mar 18, 2024
4 tasks
Comment on lines -421 to 427
if (DB::get_conn()->supportsCteQueries()) {
// Supports non-recursive CTE clause
} elseif (DB::get_conn()->supportsCteQueries(true)) {
if (DB::get_conn()->supportsCteQueries(true)) {
// Supports recursive CTE clause
} elseif (DB::get_conn()->supportsCteQueries()) {
// Supports non-recursive CTE clause
} else {
// No CTE support
}
Copy link
Member Author

Choose a reason for hiding this comment

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

Unrelated change - with the old code, the elseif condition would never have been executed because if it doesn't support non-recursive queries it definitely doesn't support recursive ones.

Copy link
Member Author

Choose a reason for hiding this comment

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

Changes here reflect the changes in the changelog for the same content

Copy link
Member Author

Choose a reason for hiding this comment

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

Unrelated changes - just noticed a couple of cases where this list about the writing style doesn't follow its own rules.

- Use gender neutral language throughout the document, unless referencing a specific person. Use them, they, their, instead of he and she, his or her.
- Use simple language and words. Avoid uncommon jargon and overly long words. Remember that not everyone speaks English as their primary language.
- Use UK English, not US English. Silverstripe CMS is proudly a New Zealand open source project we use the UK spelling and forms of English. The most common of these differences are -ize vs -ise, or -or vs our (eg color vs colour).
- Write in an active and direct voice.
- Avoid saying words like "obviously" or "of course". Things that are obvious to you as the writer may not be so obvious to the person reading the documentation.
- Keep documentation lines shorter than 120 characters.
Copy link
Member Author

Choose a reason for hiding this comment

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

We decided to explicitly not enforce this, so we shouldn't say it's a rule

Copy link
Member Author

Choose a reason for hiding this comment

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

Should be a little less blurry since it's larger, and shows both of the versioned labels

Comment on lines -32 to +34
This release includes several security fixes. Review the individual vulnerability disclosure for more detailed descriptions of each security fix. We highly encourage upgrading your project to include the latest security patches.
Some security fixes that were previously released in the January security release that are mentioned in the [Silverstripe CMS security patches January 2024](https://www.silverstripe.org/blog/silverstripe-cms-security-patches-january-2024/) blog post are listed below.

Review the individual vulnerability disclosure for more detailed descriptions of each security fix. We highly encourage upgrading your project to include the latest security patches.
Copy link
Member Author

Choose a reason for hiding this comment

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

Copied over from the beta changelog

@GuySartorelli GuySartorelli marked this pull request as ready for review March 19, 2024 00:47
Copy link
Contributor

@sabina-talipova sabina-talipova left a comment

Choose a reason for hiding this comment

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

LGTM

@sabina-talipova sabina-talipova merged commit ab61e02 into silverstripe:5.2 Mar 19, 2024
3 checks passed
@sabina-talipova sabina-talipova deleted the pulls/5.2/review-changelog branch March 19, 2024 21:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants