-
Notifications
You must be signed in to change notification settings - Fork 118
fix:Documentation: Clarify migrations are not always required #230
Conversation
app/views/docs/upgrade.phtml
Outdated
@@ -68,8 +68,8 @@ | |||
|
|||
<p>Verify that the <b>STATUS</b> doesn't have any errors and all the <b>appwrite/appwrite</b> containers have version : <?php echo APP_VERSION_STABLE; ?></p> | |||
|
|||
<h3><a href="/docs/upgrade#run-the-migration" id="migration">Running the Migration</a></h3> | |||
|
|||
<h3><a href="/docs/upgrade#run-the-migration" id="migration">Running the Migration(Optional)</a></h3> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hey! Thanks for contributing to our docs :D
We do already mention this is a notice on line 10:
docs/app/views/docs/upgrade.phtml
Line 10 in d3c1728
<p>You do not need to run migration when upgrading to a minor version. For example, going from 0.13.0 to 0.13.2 would not require running migration.</p> |
What I suggest is the following:
- Removing the
(Optional)
from the heading and adding a notice - Remove the notice text from line 10.
- Add your note in a proper notice
Please check it out |
app/views/docs/upgrade.phtml
Outdated
@@ -69,7 +67,8 @@ | |||
<p>Verify that the <b>STATUS</b> doesn't have any errors and all the <b>appwrite/appwrite</b> containers have version : <?php echo APP_VERSION_STABLE; ?></p> | |||
|
|||
<h3><a href="/docs/upgrade#run-the-migration" id="migration">Running the Migration</a></h3> | |||
|
|||
<p>[Note:You do not need to run migration when upgrading to a minor version. For example, going from 0.13.0 to 0.13.2 would not require running migration.] </p> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There's a notice element we use in our docs, it'll look like this:
-<p>[Note:You do not need to run migration when upgrading to a minor version. For example, going from 0.13.0 to 0.13.2 would not require running migration.] </p>
+<div class="notice margin-bottom">
+ <h3>Upgrading to a minor version</h3>
+ <p>You do not need to run migration when upgrading to a minor version. For example, going from 0.13.0 to 0.13.2 would not require running migration.</p>
+</div>
Thanks for checking it out |
Let me test the change out real quick and give you a render :) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, tiny grammatical suggestion, I'll merge after this :)
Co-authored-by: Vincent (Wen Yu) Ge <wenyu1999@hotmail.com>
In case you miss 👍 |
LGTM! Merged |
issue appwrite/appwrite#3624