DOC Update references from CMS 5 #644
Conversation
Also remove CMS 5 changelogs
| @@ -277,7 +277,7 @@ table may be of use: | |||
| | 5.2 + | 8.1 - 8.3 | | |||
| | 5.0 - 5.1 | 8.1 - 8.2 | | |||
There was a problem hiding this comment.
Note I intentionally kept these, since the bit above it says
if you are looking to upgrade PHP on your Silverstripe CMS site, this table may be of use
That implies the table is meant to include the previous major's PHP versions
| composer require silverstripe/blog | ||
| composer require dnadesign/silverstripe-elemental |
There was a problem hiding this comment.
Unrelated but since blog isn't commercially supported I'm removing the reference.
| Each module has a unique identifier, consisting of a vendor prefix and name. For example, the "blog" module has the | ||
| identifier `silverstripe/blog` as it is published by *Silverstripe*. To install, use the following command executed in | ||
| Each module has a unique identifier, consisting of a vendor prefix and name. For example, the "linkfield" module has the | ||
| identifier `silverstripe/linkfield` as it is published by *Silverstripe*. To install, use the following command executed in | ||
| the project root folder: | ||
|
|
||
| ```bash | ||
| composer require silverstripe/blog | ||
| composer require silverstripe/linkfield | ||
| ``` |
There was a problem hiding this comment.
Unrelated but since blog isn't commercially supported I'm removing the reference.
| So, if you're committing the change to a *4.12* minor release, the version will be *4.12.0*. | ||
| So, if you're committing the change to a *1.2* minor release, the version will be *1.2.0*. |
There was a problem hiding this comment.
Use 1.2 since that's what's used in some of the examples.
Updated the examples so all examples use this as well.
| - Add the following docblock `@deprecated 1.2.3 Use anotherMethod() instead` | ||
| - `Deprecation::notice('1.2.3', 'Use anotherMethod() instead');` to the top of the method | ||
| - Add the following docblock `@deprecated 1.2.0 Use anotherMethod() instead` | ||
| - `Deprecation::notice('1.2.0', 'Use anotherMethod() instead');` to the top of the method |
There was a problem hiding this comment.
1.2.3 would not be correct for us, since we only add these in minor releases not patches.
Not related but seems prudent to fix.
| Not all API that gets deprecated will have an equivalent replacement API in that same major version; some of the API is only available from the next major release. A good example of this is the upgrade for what powered the `SilverStripe\Control\Email\Email` class from `swiftmailer` in CMS 4 to `symfony/mailer` in CMS 5. In these cases, you'll need to upgrade to the new major version before you can access the replacement API. | ||
| Not all API that gets deprecated will have an equivalent replacement API in that same major version; some of the API is only available from the next major release. In these cases, you'll need to upgrade to the new major version before you can access the replacement API. |
There was a problem hiding this comment.
I was going to replace with a more generic examples but honestly I don't think it's needed.
Happy to add one if you feel differently.
There was a problem hiding this comment.
Please double check this page carefully, this is the one page where the changes in this PR actually matter.
| Branches with a single integer (e.g. `5`) represent either the next *major* release (if there have been no tagged releases for that release line yet) or the next *minor* release. | ||
| Branches with a single integer (e.g. `1`) represent either the next *major* release (if there have been no tagged releases for that release line yet) or the next *minor* release. | ||
|
|
||
| Branches with an integer, a dot, and another integer (e.g. `5.2`) represent either the *next patch release* for the current minor, or a patch release for a previous minor version. | ||
| Branches with an integer, a dot, and another integer (e.g. `1.2`) represent either the *next patch release* for the current minor, or a patch release for a previous minor version. |
There was a problem hiding this comment.
Use more generic 1.2 instead of CMS numbers so we don't have to update it next time, since this page doesn't reference specific modules
Note there were no upgrade guides to remove.
Issue