🚧 Original upgrading doc.
I'm keeping it around just so I know what content hasn't been restructured.
🚧 Setting outline of new upgrading guide.
I'm just outlining the TOC here.
https://github.com/silverstripe/silverstripe-upgrader/issues/72🚧 Typo correction.
🚧 Move most of original content into new structure.
📝 Documenting how to recompose your dependencies.
📝 Finish documenting the reorganise command.
📝 Add a conlusion to upgrade
📝 Drafting environment upgrade doc
Move environment upgrade doc out of change log and integrating it into the upgrading guide.
📝 Document how to namespace project
🚧 Working on step 4.
📝 Adding doc for the upgrade step.
Finalise first draft of the upgrade guide.
Remove typo
Implementing feedback on the doc.
Implementing upgrade guide feedback.wq
Add refrence to upgrade guide into change log.
Implement specific upgrade guide peer review suggestion.
Wording tweaks.
Remove reference to ACME and rewrite overview.
The end of the upgrading guide tweaks ... I think.
It's one of the most noteworthy manual changes,
let's not hide it from devs who will (correctly) start their upgrade process by looking at the 4.0.0 guide
- Use "Removed/Changed/Added/Moved" prefixes to make content more scannable
- Removed "change" vs "remove" distinction in subheadings (hard to separate, and not meaningful in practice)
- Linearised messages, less nesting - easier to parse (don't need to remember context from a few lines above)
- Simplified language (e.g. "use" instead of "please use")
- Simplified headline wording (remove repetitive "upgrade code that uses X")
- More anchor links across sections
- More use of diffs to clearly communicate before/after states
- Consistently apply backtick code formatting
- Consistently use "()" to denote methods (easier to read)
- Removed duplicate SQLQuery instructions (and simplified the augmentSQL example)
- Add new composer.json intro
It's currently broken (doesn't rewrite subsequent links),
and is of questionable use. It was introduced during a time
when PHP didn't have a built-in webserver (I think).
Virtually ever webserver will have rewriting capabilities these days (even IIS!),
and if you struggle with the setup as a new user, you can just fall back to PHP's built-in webserver.
This doesn't affect installation capabilities, since these are triggered via install.php.
