Skip to content

Commit 86a3a14

Browse files
refactor updating doc
1 parent 6463db5 commit 86a3a14

3 files changed

Lines changed: 154 additions & 69 deletions

File tree

src/essentials-for-yootheme-pro/v3.0-beta/installation.md

Lines changed: 0 additions & 69 deletions
Original file line numberDiff line numberDiff line change
@@ -29,72 +29,3 @@ After successful installation, verify that the **Essentials YOOtheme Pro** plugi
2929
::: warning First-Time Setup
3030
After installation, you may need to clear your site's cache and refresh the Customizer for all features to become available.
3131
:::
32-
33-
## Updating
34-
35-
Keep your Essentials installation up-to-date with the latest features and security improvements. You can update manually or set up automatic updates through your platform.
36-
37-
### Prerequisites for Automatic Updates
38-
39-
Before setting up automatic updates, ensure you have:
40-
41-
1. A valid Download ID from your ZOOlanders account
42-
2. The correct minimum stability setting configured
43-
3. A recent backup of your site
44-
45-
### Download ID
46-
47-
An Essentials Download ID is a unique alphanumeric code generated for each website. It is required to update Essentials. You can find and manage your Download IDs in the [Download IDs](https://zoolanders.com/account/download-ids) section of your account.
48-
49-
![Download ID](./assets/download-id.png)
50-
51-
Once obtained, set it in your site, an action that slightly differs for each platform.
52-
53-
::: details Joomla
54-
![Download ID Joomla](./assets/download-id-joomla.png)
55-
56-
Go to `System -> Update -> Update Sites` and locate `Essentials YOOtheme Pro` where you can input your Download ID.
57-
:::
58-
59-
::: details WordPress
60-
![Download ID WordPress](./assets/download-id-wordpress.png)
61-
62-
Go to `Global Settings -> ZOOlanders` panel where you can input your Download ID.
63-
:::
64-
65-
### Minimum Stability
66-
67-
| Release | Description |
68-
| --- | --- |
69-
| *Stable* | This release is a version which has been thoroughly tested by both our team and the community. Use it for production sites. |
70-
| *Beta* | This release is a version which has been thoroughly tested by our team. Use it to help us test and prevent issues in the Stable release. |
71-
72-
::: details Joomla
73-
In Joomla go to the Installer Options in the **Global Configuration**.
74-
75-
![Minimum Stability Joomla](./assets/minimum-stability.webp)
76-
77-
**Notice** that this option applies to all theme and extension updates.
78-
:::
79-
80-
::: details WordPress
81-
In WordPress go to the **ZOOlanders Settings Panel** in Global Settings.
82-
83-
![Minimum Stability WordPress](./assets/download-id-wordpress.png)
84-
:::
85-
86-
### Updating Major Release
87-
88-
When updating Essentials v1.x to v2.x, or v2.2 to v2.3, plan carefully as those version introduce major changes and have specific compatibility with YOOtheme Pro. In order to properly update, follow these steps in the given order.
89-
90-
1. Make a full, restorable backup of the site.
91-
1. Head over to *System > Plugins* and disable the *Essentials* plugin.
92-
1. Upgrade YOOtheme Pro to latest stable version.
93-
1. Upgrade Essentials to latest stable version.
94-
1. Head over to the plugins manager and enable back the *Essentials* plugin.
95-
96-
Thoroughly clear all caches, and test. If anything goes wrong, restore the backup and reach out support.
97-
98-
## Upgrading
99-
100-
The upgrade from Essentials Freemium to Premium version is as simple as [installing](./#installation) the premium package without uninstalling the freemium one. The upgrade process must be done manually, after that automatic updates will take over.

src/essentials-for-yootheme-pro/v3.0-beta/sidebar.js

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,10 @@ const MainSidebar = [
4141
text: 'Installation',
4242
link: '/installation',
4343
},
44+
{
45+
text: 'Updating',
46+
link: '/updating',
47+
},
4448
],
4549
},
4650
{
Lines changed: 150 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,150 @@
1+
# Updating
2+
3+
Keep your Essentials installation up-to-date with the latest features and security improvements. You can update manually, use one-click updates, or set up automatic background updates through your platform.
4+
5+
::: tip
6+
Before making any updates perform a **full backup** of your site and make sure the backup is recoverable.
7+
:::
8+
9+
## Update Manually
10+
11+
Manual updates allow you to download and install Essentials updates directly from your site without relying on automatic update systems. This method gives you full control over when updates are applied and is useful for sites with restricted server permissions or custom hosting environments.
12+
13+
### Download
14+
15+
1. Log in to your [ZOOlanders account](https://zoolanders.com/account)
16+
1. Go to **Downloads**
17+
1. Find **Essentials YOOtheme Pro** targeted release
18+
1. Click **Download** to save the release `.zip` file
19+
20+
### Install
21+
22+
::: details Joomla
23+
24+
1. Log in to your Joomla admin panel
25+
1. Navigate to `System → Install → Extensions`
26+
1. Under **Upload Package File**, click **Browse** and select the downloaded `.zip` file
27+
1. Click **Upload & Install**
28+
1. Once installation is complete make sure the plugin is enabled
29+
:::
30+
31+
::: details WordPress
32+
33+
1. Log in to your WordPress admin dashboard
34+
1. Go to `Plugins → Add New Plugin`
35+
1. Click **Upload Plugin** at the top
36+
1. Click **Choose File** and select the downloaded `.zip` file
37+
1. Click **Install Now**, confirm when prompted about overriding current
38+
1. Once installation is complete make sure the plugin is active
39+
:::
40+
41+
### Verify
42+
43+
1. **Check version number** - Confirm Essentials shows the new version number in your admin panel
44+
2. **Test functionality** - Verify your site works correctly (forms, dynamic content, etc.)
45+
3. **Clear caches** - Clear all site and browser caches
46+
4. **Monitor for errors** - Check error logs for any issues over the next few hours
47+
48+
::: tip
49+
If you encounter issues after a manual update, restore your backup and contact support with error details from your site logs.
50+
:::
51+
52+
## Update Automatically
53+
54+
One-click updates allow you to manually trigger updates with a single click from your site's admin panel. Both Joomla and WordPress can be configured to check for and install the latest Essentials updates with minimal effort.
55+
56+
Before using one-click updates, ensure to:
57+
58+
<!-- 1. **A valid Download ID** from your ZOOlanders account - required for authentication and update verification
59+
2. **The correct minimum stability setting** - determines which release versions to receive (Stable for production sites) -->
60+
61+
### Set Your Download ID
62+
63+
![Download ID](./assets/download-id.png)
64+
65+
An Essentials Download ID is a unique alphanumeric code generated for each website. It authenticates update requests and is required for automatic updates to function.
66+
67+
1. Log in to your [ZOOlanders account](https://zoolanders.com/account)
68+
1. Navigate to [Download IDs](https://zoolanders.com/account/download-ids)
69+
1. Copy your Download ID from your website entry (or generate a new one as needed)
70+
1. Configure it in your platform's settings.
71+
72+
::: details Joomla
73+
74+
1. Log in to your Joomla admin panel
75+
2. Navigate to `System → Update → Update Sites`
76+
3. Find `Essentials YOOtheme Pro` in the list
77+
4. Click to edit it and paste your Download ID in the designated field
78+
5. Save the changes
79+
80+
![Download ID Joomla](./assets/download-id-joomla.png)
81+
:::
82+
83+
::: details WordPress
84+
85+
1. Log in to your WordPress admin dashboard
86+
2. Go to `Settings → Global Settings` (or the top-level settings menu)
87+
3. Locate the **ZOOlanders** panel/section
88+
4. Paste your Download ID in the provided field
89+
5. Click **Save Changes**
90+
91+
![Download ID WordPress](./assets/download-id-wordpress.png)
92+
:::
93+
94+
### Set Minimum Stability Level
95+
96+
The minimum stability setting determines which types of releases your site receives.
97+
98+
| Release | When to Use | Testing |
99+
| --- | --- | --- |
100+
| **Stable** | Production sites in live environments | Thoroughly tested by both our team and the community |
101+
| **Beta** | Development/testing sites or early adopters | Tested by our team; helps identify issues before stable release |
102+
103+
::: details Joomla
104+
105+
1. Log in to your Joomla admin panel
106+
2. Go to `System → Global Configuration`
107+
3. Open the **Installer** tab
108+
4. Set **Minimum Stability** to your preferred level
109+
110+
![Minimum Stability Joomla](./assets/minimum-stability.webp)
111+
112+
**Important:** This setting applies to *all* extension and theme updates on your Joomla site, not just Essentials.
113+
:::
114+
115+
::: details WordPress
116+
117+
1. Log in to your WordPress admin dashboard
118+
2. Go to `Settings → Global Settings`
119+
3. Find the **ZOOlanders** panel
120+
4. Select your preferred **Minimum Stability** level
121+
5. Click **Save Changes**
122+
123+
![Minimum Stability WordPress](./assets/download-id-wordpress.png)
124+
125+
This setting affects only Essentials updates on your WordPress site.
126+
:::
127+
128+
### Trigger Update
129+
130+
Navigate to `System → Update Manager` in Joomla or `Plugins → Installed Plugins` in WordPress and look for Essentials. If a new version is available it should be listed and presented with an option to update. The system will make the download and update for you automatically.
131+
132+
::: tip
133+
If Essentials update is not listed, but there is a new release, try refetching or clear system cache.
134+
:::
135+
136+
## Update Major Release
137+
138+
When updating Essentials v1.x to v2.x, or v2.2 to v2.3, plan carefully as those version introduce major changes and have specific compatibility with YOOtheme Pro. In order to properly update, follow these steps in the given order.
139+
140+
1. Make a full, restorable backup of the site.
141+
1. Head over to *System > Plugins* and disable the *Essentials* plugin.
142+
1. Upgrade YOOtheme Pro to latest stable version.
143+
1. Upgrade Essentials to latest stable version.
144+
1. Head over to the plugins manager and enable back the *Essentials* plugin.
145+
146+
Thoroughly clear all caches, and test. If anything goes wrong, restore the backup and reach out support.
147+
148+
## Upgrade From Freemium
149+
150+
The upgrade from Essentials Freemium to Premium version is as simple as [installing](./#installation) the premium package without uninstalling the freemium one. The upgrade process must be done manually, automatic updates will be possible after.

0 commit comments

Comments
 (0)