Skip to content

Commit ae96278

Browse files
benkeenbenkeen
committed
Upgrading documentation update
1 parent 6ef13e9 commit ae96278

File tree

6 files changed

+101
-32
lines changed

6 files changed

+101
-32
lines changed

‎.nvmrc

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
v16.19.1

‎README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,8 @@ If you want to run the documentation locally, you'll need to do the following:
3636
2. Install Jekyll via the [instructions here](http://jekyllrb.com/docs/installation/)
3737
3. Once it's been installed, open up your terminal/command line, navigate to the root folder of this repo and enter:
3838
```
39-
npm install
40-
npm install -g grunt-cli
39+
yarn install
40+
yarn global add grunt-cli
4141
```
4242

4343
4. Next, start up the doc with `grunt start` (I need to run `sudo grunt start` myself).

‎_includes/nav_upgrading.html

+4
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@ <h4 {% if include.selected == 'upgrading' %}class="selected"{% endif %}>
22
<a href="{{site.baseurl}}/upgrading/">Upgrading</a>
33
</h4>
44

5+
<h4 {% if include.selected == 'old_versions' %}class="selected"{% endif %}>
6+
<a href="{{site.baseurl}}/upgrading/old_versions">Old version upgrading instructions</a>
7+
</h4>
8+
59
<ul>
610
<li {% if include.selected == '2_0_3' %}class="selected"{% endif %}>
711
<a href="{{site.baseurl}}/upgrading/2_0_3">2.0.3</a>

‎upgrading/2_0_3.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
breadcrumbs:
66
- Upgrading,/upgrading/
77
- Upgrading to 2.0.3
8-
prev: Upgrading,/upgrading
8+
prev: Old version upgrading instructions,/upgrading/old_versions
99
next: Upgrading to 2.1.0,/upgrading/2_1_0/
1010
categories: upgrading
1111
---

‎upgrading/index.html

+72-29
Original file line numberDiff line numberDiff line change
@@ -4,47 +4,100 @@
44
heading: Upgrading
55
breadcrumbs:
66
- Upgrading
7-
next: Upgrading to 2.0.3,/upgrading/2_0_3
7+
next: Old version upgrading instructions,/upgrading/old_versions
88
categories: upgrading
99
page_type: introduction
1010
---
1111

1212
{% include open_section.html nav='nav_upgrading.html' selected='upgrading' %}
1313

1414
<p>
15-
{% include screenshot.html item="i176.gif" %}
1615
Form Tools is made up of a separate of components: the Core, Modules, Themes and the API - each of which needs
17-
to be updated individually. Since upgrading each component one by one would be rather tiresome, we created a
18-
upgrade script to simplify matters.
19-
</p>
16+
to be updated individually. Up until 2020, the Form Tools website offered a simple Upgrade script which did
17+
the work of calculating exactly what packages you needed/wanted to update, and generate a custom zipfile of all
18+
the components. But alas, alack, due to hosting costs we had to downgrade the website, which meant
19+
we could no longer offer the upgrade functionality. We're very sorry! We miss it too!
20+
</p>
21+
22+
<h3>Manual upgrade instructions</h3>
2023

21-
<p class="alert alert-info">
22-
The following pages outline special Form Tools versions. If your installation is very out of date and you want
23-
to upgrade to the most recent version, upgrade to 2.0.3, THEN upgrade to 2.1.0, then to 3.0.0.
24+
<p>
25+
So instead, here's how you go about upgrading.
2426
</p>
2527

26-
<h3>General upgrade instructions</h3>
28+
<h4>1. Check the unique version list</h4>
29+
30+
<p>
31+
Most versions can be updated without special steps, but not all.
32+
</p>
33+
<p>
34+
Take a look at the versions in the sidebar to the left. Those are special versions that required special
35+
installation steps. To be blunt, they are very old. You may just want to consider doing a fresh installation,
36+
but if you do want to update to the latest Form Tools version you'll need to upgrade to each of those versions
37+
one by one, before updating to the very latest version. See those pages for more information - but the steps
38+
below apply to any Form Tools version, so you'll need to repeat them for each of those versions.
39+
</p>
40+
41+
<h4>2. Get the upgrade files</h4>
2742

2843
<ol>
29-
<li>Backup your database and files. No, seriously! Yes, it's a pain but do it anyway.</li>
3044
<li>
31-
Log into your Form Tools installation and click the "Upgrade" link. This appears in different locations
32-
in the UI depending on your selected theme. The default theme shows it in the top right; Classic Grey and
33-
Deep Blue show it in the left navigation menu.
45+
Browse the list of <a href="https://modules.formtools.org">modules</a> and <a href="https://modules.formtools.org">themes</a>
46+
on the website to find those packages you want to upgrade. (To see the available versions, click on the Download buttons).
47+
For the available Core and API versions, visit the <a href="https://formtools.org/download/">download page</a>
48+
and click on those items.
3449
</li>
3550
<li>
36-
On the Form Tools site upgrade page, choose the components you want to upgrade and generate and download
37-
the zipfile.
51+
Download the appropriate versions from <a href="https://github.com/formtools">github</a>. Github stores all
52+
the source code under the "Releases" area for each package.
53+
</li>
54+
</ol>
55+
56+
<h4>3. Preparing files</h4>
57+
58+
<ol>
59+
<li>
60+
Unzip the packages, one by one. Modules and themes will contain a single folder named something like <i>module-export_manager-3.3.0</i>.
3861
</li>
3962
<li>
40-
Log out of Form Tools in a web browser and go to the login page.
63+
For modules and themes, rename that folder to remove the <i>module-</i> or <i>theme-</i> prefix, and the -X.Y.Z <i>suffix</i>. In
64+
this example, the final folder should just be named <i>export_manager</i>.
4165
</li>
4266
<li>
43-
On your computer, unzip the file and upload the folder to your Form Tools folder on your server, overwriting
44-
the old files.
67+
Don't worry about the API or Core folders. They don't need to be renamed.
4568
</li>
69+
</ol>
70+
71+
<h4>4. Updating the files</h4>
72+
73+
<ol>
74+
<li>Before we do this next bit, <b>backup your database and files</b>. No, seriously! Yes, it's a pain but do it anyway.</li>
4675
<li>
47-
On the Form Tools login page, click refresh. You should see a "You've been upgrade to ..." message.
76+
For this next part, we're going to overwrite the old files on your server. Generally this means FTPing of SFTPing
77+
the files and overwriting the old ones.
78+
</li>
79+
<li>
80+
First do the Core (if you're updating that part). For that, just overwrite the contents of those files on
81+
your server.
82+
83+
<div class="alert alert-warning">
84+
Note that if this is a LOCAL installation, often operating systems will just remove entire folder and replace them
85+
with the new ones, so special files - like your all-important <b>global/config.php</b> file that contains all
86+
your settings - will be overwritten. So for local installations, overwriting the files folder by folder
87+
is the (slow and annoying!) way to go. For FTP/SFTP you can just drag & drop and it'll do a merge overwrite -
88+
keeping any files that already existed & weren't overwritten.
89+
</div>
90+
</li>
91+
<li>
92+
For modules and themes, do the same. Find the /modules and /themes subfolders and overwrite their contents
93+
there.
94+
</li>
95+
<li>
96+
Lastly, the API is found in global/api. Again, just overwrite the files.
97+
</li>
98+
<li>
99+
Load up Form Tools in your browser and go to the Form Tools login page. You should see a "You've been
100+
upgraded to ..." message right away.
48101
</li>
49102
<li>
50103
Log in as the administrator and go to the Modules page. There, click the Upgrade button for all modules
@@ -53,15 +106,5 @@ <h3>General upgrade instructions</h3>
53106
<li>You're done!</li>
54107
</ol>
55108

56-
<hr size="1" />
57-
58-
<h3>Upgrading Form Tools 1.x to 2.0.x</h3>
59-
60-
<p>
61-
Form Tools 1 is very, very old! We used to have an upgrade script to allow you to update to
62-
an old version of Form Tools 2, but even that is now out of date. I'm afraid there are no longer
63-
ways to update to the new versions.
64-
</p>
65-
66109

67110
{% include close_section.html %}

‎upgrading/old_versions.html

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
layout: default
3+
navPage: docs
4+
heading: Upgrading
5+
breadcrumbs:
6+
- Upgrading
7+
prev: Upgrading,/upgrading
8+
next: Upgrading to 2.0.3,/upgrading/2_0_3
9+
categories: upgrading
10+
page_type: introduction
11+
---
12+
13+
{% include open_section.html nav='nav_upgrading.html' selected='old_versions' %}
14+
15+
<p>
16+
The following pages contain some specifics about upgrading to some older versions of Form Tools and unique
17+
steps you need to do for those versions.
18+
</p>
19+
20+
21+
{% include close_section.html %}

0 commit comments

Comments
 (0)