@@ -232,7 +232,7 @@ <h3>Table Of Contents</h3>
232232 < li >
233233 < a href ="#docs.5 "> Contributing To WebTerminal Project</ a >
234234 < 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 >
236236 < li > < a href ="#docs.5.2 "> Guidelines</ a > </ li >
237237 < li > < a href ="#docs.5.3 "> Entry Points</ a > </ li >
238238 </ ol >
@@ -1281,7 +1281,7 @@ <h1 id="docs.5">5. Contributing To WebTerminal Project</h1>
12811281 < a target ="_blank " href ="https://github.com/intersystems-ru/webterminal "> GitHub</ a > .
12821282 This section describes the basic guidelines and principles of contributing.
12831283 </ 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 >
12851285 < p >
12861286 The development workflow of Caché WebTerminal lies completely outside Caché
12871287 (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>
13321332 </ li >
13331333 < li >
13341334 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
13371337 to the latest version and the location of the file respectively. Note that the latest version
13381338 bust be < b > greater</ b > than the previous version. Make sure that the JSON structure is still
13391339 valid.
13401340 </ li >
13411341 < 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
13431343 < code class ="inline "> docs/index.html</ code > file.
13441344 </ li >
13451345 < li >
@@ -1350,16 +1350,22 @@ <h2 id="docs.5.1">5.1. Development Workflow Set Up</h2>
13501350 < p >
13511351 A special care must be taken while altering WebTerminal < b > updating mechanism</ b >
13521352 (< 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).
13551356 </ p >
13561357 < p >
13571358 You can put the < code class ="inline "> /motd</ code > (message of the day) message to
13581359 < code class ="inline "> docs/terminal.json</ code > : all WebTerminal users will start to see this
13591360 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
13611362 manually (hopefully never).
13621363 </ 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 >
13631369 < h2 id ="docs.5.2 "> 5.2. Guidelines</ h2 >
13641370 < p >
13651371 There are several guidelines you should consider if you want to contribute to
0 commit comments