Add initial Solidus upgrades documentation #2641
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
I just realized that I need to update this branch with a section about version maintenance and EOL policies. Edit: ✔️ |
benjaminwil
force-pushed
the
upgrades_documentation
branch
from
452a8d2
to
07c52a7
Compare
swcraig
reviewed
Mar 21, 2018
guides/upgrades/overview.md
Outdated
| extensions list][extensions] also includes a compatibility chart for each major | ||
| and minor version of Solidus. | ||
|
|
||
| [extensions]: http://eextensions.solidus.io |
There was a problem hiding this comment.
There's an extra "e", in "extensions".
| Commits are added sparingly to ensure that stores can always stay on the latest | ||
| patch version. | ||
|
|
||
| The internal call structure should be maintained so that any overrides to method |
There was a problem hiding this comment.
Should this say "methods"?
|
|
||
| ### Minor versions | ||
|
|
||
| Minor versions (`x.Y.z`) is for any backwards-compatible changes to the public |
benjaminwil
force-pushed
the
upgrades_documentation
branch
2 times, most recently
from
267fb38
to
d00cfb0
Compare
This adds an article explaining Solidus's versioning guidelines from [Solidus's GitHub wiki][1]. [1]: https://github.com/solidusio/solidus/wiki
benjaminwil
force-pushed
the
upgrades_documentation
branch
from
d00cfb0
to
f31a3e9
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This adds two short articles describing Solidus's core goals in regards to upgrades and how Solidus handles versioning and semver.
This is part a larger project to improve Solidus's documentation. See this gist with the high-level table of contents. Where and how this documentation will exist is still up for discussion.