diff --git a/docs/pages/suite/suite-step-0.md b/docs/pages/suite/suite-step-0.md index ef4fa659f..40d720cbe 100644 --- a/docs/pages/suite/suite-step-0.md +++ b/docs/pages/suite/suite-step-0.md @@ -1,6 +1,6 @@ --- title: "Step 0: Get ready" -summary: Before you begin, please install Chrome and Node JS . +summary: Before you begin, please install Chrome and Node JS. sidebar: suite_sidebar permalink: suite-step-0.html toc: false @@ -10,7 +10,7 @@ This *Getting Started Guide* will quickly show you the very basics of Superalgos ## Chrome is the Only Tested Browser -Before you begin, it is highly reccommended that you install Chrome and set it up as your default browser. +Before you begin, it is highly recommended that you install Chrome and set it up as your default browser. {% include note.html content="Use Chrome so that you have a similar environment as the dev team in case you need help. We are not testing on any other browsers, and it is a well-known fact that browsers behave differently." %} @@ -25,3 +25,7 @@ Please install Node JS, an open-source server environment required to run Supera **3. Run the installer** and go through the process until Node JS is fully installed. {% include note.html content="Windows users may choose to install Node JS and run the system in the full version of the server too." %} + +## Are You Upgrading to a New Version of Superalgos? + +If you have run Superalgos before, read the best practices for [upgrading the system](suite-upgrading-your-existing-instalation.html) as a reminder, and take your time before you commit to the upgrade. \ No newline at end of file diff --git a/docs/pages/suite/suite-step-4.md b/docs/pages/suite/suite-step-4.md index 08b97bb68..c151b0082 100644 --- a/docs/pages/suite/suite-step-4.md +++ b/docs/pages/suite/suite-step-4.md @@ -1,6 +1,6 @@ --- title: Import a Workspace -summary: Importing a workspace is a simple drag and drop operation. +summary: If you are upgrading to a new version of Superalgos, you need to import a new workspace. sidebar: suite_sidebar permalink: suite-step-4.html toc: false @@ -8,12 +8,12 @@ toc: false The workspace is an important concept within Superalgos. It is the entity that holds all the information handled by the system. In practical terms, it is a file that can be backed up, shared, and restored in the system. -For your convenience, the system ships with a default workspace containing a ready-to-use set-up. +{% include important.html content="For your convenience, the system ships with a default workspace that is restored automatically the first time you fire up the system. If this is the first time you are running the system, the workspace has already been loaded and you do not need to restore it manually. If that is the case, skip the following instructions and go straight to the next step." %} -## Start Here +## If You Are Upgrading to a New Version of Superalgos -**1. Locate the file ```Share - My Workspace.json```** in the root of the ```Superalgos-master``` folder. +**1. Locate the file ```Workspace.json```** in the root of the ```Superalgos-master``` folder. **2. Left-click on the file and drag it over the browser** where the system is running. You will notice the system recognizes your intent and pulls de slider up, showing the design space. -**3. Drop the workspace file on the design space** and wait for a few seconds. You should see a ring around the workspace icon, indicating the progress of the import action. Once the ring dissappears, the import operation is over an you are free to start using the system. \ No newline at end of file +**3. Drop the workspace file on the design space** and wait for a few seconds. You should see a ring around the workspace icon, indicating the progress of the import action. Once the ring disappears, the import operation is over and you are free to start using the system. \ No newline at end of file diff --git a/docs/pages/suite/suite-upgrading-your-existing-instalation.md b/docs/pages/suite/suite-upgrading-your-existing-instalation.md index b0f2f389b..bf0c5905c 100644 --- a/docs/pages/suite/suite-upgrading-your-existing-instalation.md +++ b/docs/pages/suite/suite-upgrading-your-existing-instalation.md @@ -49,4 +49,8 @@ This is the time to restore any of the work you may have backed up earlier, on t Before going deep back to work, it is always recommeended to test the new version a bit and make sure that your existing work performs as you would expect. -If you run into any issues, feel free to drop us a line in our Community. \ No newline at end of file +If you run into any issues, feel free to drop us a line in our Community. + +## 7. Check the Gettings Started Guide + +It would be wise to go through the potentially new *Getting Started Guide* in the documentation, as it may reveal important information. \ No newline at end of file