Skip to content
This repository has been archived by the owner on Sep 29, 2023. It is now read-only.

fix:Documentation: Clarify migrations are not always required #230

Merged
merged 6 commits into from
Aug 15, 2022
Merged

fix:Documentation: Clarify migrations are not always required #230

merged 6 commits into from
Aug 15, 2022

Conversation

us3r64bit
Copy link
Contributor

@us3r64bit us3r64bit commented Aug 3, 2022

@@ -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>
Copy link
Contributor

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:

<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

@us3r64bit
Copy link
Contributor Author

Please check it out
Tell me if there is anything to change

@@ -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>
Copy link
Contributor

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>

This will render it in a blue notice like this.
Screen Shot 2022-08-08 at 4 10 15 PM

@us3r64bit
Copy link
Contributor Author

Thanks for checking it out
I've made changes as per your request

@gewenyu99
Copy link
Contributor

Let me test the change out real quick and give you a render :)

@gewenyu99
Copy link
Contributor

Screen Shot 2022-08-11 at 2 41 00 PM

Screen Shot 2022-08-11 at 2 41 34 PM

Copy link
Contributor

@gewenyu99 gewenyu99 left a 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 :)

app/views/docs/upgrade.phtml Outdated Show resolved Hide resolved
us3r64bit and others added 2 commits August 12, 2022 01:23
Co-authored-by: Vincent (Wen Yu) Ge <wenyu1999@hotmail.com>
@us3r64bit
Copy link
Contributor Author

In case you miss 👍
I've made changes as per your suggestion 😄

@gewenyu99
Copy link
Contributor

LGTM! Merged

@gewenyu99 gewenyu99 merged commit 860f9d8 into appwrite:main Aug 15, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants