@@ -232,7 +232,7 @@ <h3>Table Of Contents</h3>
232
232
< li >
233
233
< a href ="#docs.5 "> Contributing To WebTerminal Project</ a >
234
234
< ol >
235
- < li > < a href ="#docs.5.1 "> Development Workflow Set Up </ a > </ li >
235
+ < li > < a href ="#docs.5.1 "> Development Workflow</ a > </ li >
236
236
< li > < a href ="#docs.5.2 "> Guidelines</ a > </ li >
237
237
< li > < a href ="#docs.5.3 "> Entry Points</ a > </ li >
238
238
</ ol >
@@ -1281,7 +1281,7 @@ <h1 id="docs.5">5. Contributing To WebTerminal Project</h1>
1281
1281
< a target ="_blank " href ="https://github.com/intersystems-ru/webterminal "> GitHub</ a > .
1282
1282
This section describes the basic guidelines and principles of contributing.
1283
1283
</ p >
1284
- < h2 id ="docs.5.1 "> 5.1. Development Workflow Set Up </ h2 >
1284
+ < h2 id ="docs.5.1 "> 5.1. Development Workflow</ h2 >
1285
1285
< p >
1286
1286
The development workflow of Caché WebTerminal lies completely outside Caché
1287
1287
(without using Caché Studio / Atelier) and is possible for any platform. It
@@ -1332,14 +1332,14 @@ <h2 id="docs.5.1">5.1. Development Workflow Set Up</h2>
1332
1332
</ li >
1333
1333
< li >
1334
1334
Append a record describing changes to < code class ="inline "> docs/terminal.json</ code > file.
1335
- You can accurately copy-paste-edit records from the previous records. Make sure you changed
1336
- the < code class ="inline "> /versions/X/v</ code > and < code class ="inline "> /versions/X/url</ code >
1335
+ You can accurately copy-paste-edit record from the previous records. Make sure you changed
1336
+ the < code class ="inline "> /versions/X/v</ code > and < code class ="inline "> /versions/X/url</ code > properties
1337
1337
to the latest version and the location of the file respectively. Note that the latest version
1338
1338
bust be < b > greater</ b > than the previous version. Make sure that the JSON structure is still
1339
1339
valid.
1340
1340
</ li >
1341
1341
< li >
1342
- If the change is pretty important, add it to visible releases by editing
1342
+ If the change is pretty important, add it to visible releases (this website) by editing
1343
1343
< code class ="inline "> docs/index.html</ code > file.
1344
1344
</ li >
1345
1345
< li >
@@ -1350,16 +1350,22 @@ <h2 id="docs.5.1">5.1. Development Workflow Set Up</h2>
1350
1350
< p >
1351
1351
A special care must be taken while altering WebTerminal < b > updating mechanism</ b >
1352
1352
(< code class ="inline "> WebTerminal.Updater</ code > class). If you push a broken change, WebTerminal
1353
- will update itself normally, but possibly only for the first time. For the next updates WebTerminal
1354
- will use the new update code which can make it never update again (user will need to reinstall it manually).
1353
+ will update itself normally for the first time. During the next updates WebTerminal
1354
+ will use the new update code which can possibly make it never update again, and user
1355
+ will need to reinstall WebTerminal manually).
1355
1356
</ p >
1356
1357
< p >
1357
1358
You can put the < code class ="inline "> /motd</ code > (message of the day) message to
1358
1359
< code class ="inline "> docs/terminal.json</ code > : all WebTerminal users will start to see this
1359
1360
message in console. Do it < b > only when absolute necessary</ b > : do not distract users. This functionality
1360
- is kept for the critical WebTerminal update faults: when users will need to reinstall WebTerminal
1361
+ is kept for the critical WebTerminal faults, when users will need to reinstall WebTerminal
1361
1362
manually (hopefully never).
1362
1363
</ p >
1364
+ < p >
1365
+ One more thing for repository maintainers: **never** rename the repository or move the
1366
+ < code class ="inline "> docs</ code > (website) to the custom domain until you will be completely sure
1367
+ that this won't break the WebTerminal auto-updating mechanism (update URLs).
1368
+ </ p >
1363
1369
< h2 id ="docs.5.2 "> 5.2. Guidelines</ h2 >
1364
1370
< p >
1365
1371
There are several guidelines you should consider if you want to contribute to
0 commit comments