Chg all refs to tech docs - now just docs

TotallyInformation · Feb 11, 2023 · 1baacf4 · 1baacf4
1 parent a6ea616
commit 1baacf4
Show file tree

Hide file tree

Showing 16 changed files with 24 additions and 24 deletions.
diff --git a/TODO.md b/TODO.md
@@ -1 +1 @@
-Moved to the [Tech Docs roadmap page](https://totallyinformation.github.io/node-red-contrib-uibuilder/#/roadmap).
+Moved to the [Documentation roadmap page](https://totallyinformation.github.io/node-red-contrib-uibuilder/#/roadmap).
diff --git a/docs/README.md b/docs/README.md
@@ -176,4 +176,4 @@ Some information on testing uibuilder. Unfortunately, I have no real clue about
 * [v1 Changelog](archived/CHANGELOG-v1.md)
 
 > [!TIP]
-> These are the docs for uibuilder v6. If you need the v5 or earlier docs, the easiest way is to set up a test instance of Node-RED and manually install the appropriate uibuilder version: `npm install node-red-contrib-uibuilder@5` then use the tech docs links from a uibuilder node.
+> These are the docs for uibuilder v6. If you need the v5 or earlier docs, the easiest way is to set up a test instance of Node-RED and manually install the appropriate uibuilder version: `npm install node-red-contrib-uibuilder@5` then use the documentation links from a uibuilder node.
diff --git a/docs/index.html b/docs/index.html
@@ -1,9 +1,9 @@
 <!DOCTYPE html>
 <html lang="en"><head>
     <meta charset="UTF-8">
-    <title>uibuilder Technical Documentation v5</title>
+    <title>uibuilder Documentation v6</title>
 
-    <meta name="description" content="uibuilder Technical Documentation v6">
+    <meta name="description" content="uibuilder Documentation v6">
     <meta name="viewport" content="width=device-width, initial-scale=1">
     <link rel="icon" type="image/png" href="./images/favicon.ico">
 
@@ -84,7 +84,7 @@
         // https://docsify.js.org/
         // https://jhildenbiddle.github.io/docsify-themeable
         window.$docsify = { //  eslint-disable-line no-undef
-            name: 'uibuilder Technical Documentation v6',
+            name: 'uibuilder Documentation v6',
             repo: 'TotallyInformation/node-red-contrib-uibuilder',
             homepage: 'README.md',
 

diff --git a/docs/nodes/uibuilder.md b/docs/nodes/uibuilder.md
@@ -50,7 +50,7 @@ The `uibuilder Details` button opens a page showing the full configuration of ui
 
 The `Instance Details` button opens a page with a summary of the configuration and web routes for this instance.
 
-The `Tech Docs` button opens the local copy of this documentation.
+The `Docs` button opens the local copy of this documentation.
 
 ### Info panel
 

diff --git a/docs/roadmap.md b/docs/roadmap.md
@@ -50,7 +50,7 @@ Current focus (beyond what has already been developed) is on:
 * _STARTED_. Creating a new front-end library. Simplified and more robust, using ES2019 and supporting configuration-driven web interfaces.
 * _STARTED_, see [web-components](https://github.com/TotallyInformation/web-components). Creating W3C web components to replace the VueJS ones - especially for the ones baked into the fe code. Noting that v5 already contains a non-Vue toast notification feature.
 * _STARTED_. Displaying and enabling updatable packages in the package manager. The data is now in place, the Editor panel needs updating.
-* Continuing to improve the technical documentation. Updating details and changes, adding how-to's, moving some things from the WIKI. Improving language consistency.
+* Continuing to improve the documentation. Updating details and changes, adding how-to's, moving some things from the WIKI. Improving language consistency.
 * Start moving towards ECMA Modules rather than CommonJS.
 
 Next immediate focus will be on:
@@ -293,7 +293,7 @@ To see what is currently being developed, please look at the "Unreleased" sectio
 
 
 * Updates to Documentation
-  * Tech Docs: Update glossary with ESM, ECMA, UMD, IIFE
+  * Update glossary with ESM, ECMA, UMD, IIFE
   * Split the new client library, move _ui features to separate page.
   * Add message interaction diagram to "pre-defined-msgs.md"
   * Add note to documentation for the library manager that you can install LOCAL folders.

diff --git a/docs/uib-configuration.md b/docs/uib-configuration.md
@@ -97,7 +97,7 @@ This file contains the global settings for Node-RED. You can add a new property
 
         /** Controls whether the uibuilder instance API feature is enabled
          *  Off by default since uncontrolled instance api's are a security and 
-         *  operational risk. Use with caution. See Tech Docs for details.
+         *  operational risk. Use with caution. See Docs for details.
          */
         instanceApiAllowed: true,
    },
@@ -163,4 +163,4 @@ Normally, you will expect to see at least the following:
 
 * `scripts/` - Optional folder. Used for utility scripts that might be needed to help with build processes and the like.
 
-* _`node_modules/` - Not directly part of uibuilder. This folder will exist if you have locally installed any dependencies for this uibuilder instance. Typically, these would be "dev dependencies" defined in the package.json file and used as part of a build process. You do not need to back these up or commit them to a source code repository._
+* _`node_modules/` - Not directly part of uibuilder. This folder will exist if you have locally installed any dependencies for this uibuilder instance. Typically, these would be "dev dependencies" defined in the package.json file and used as part of a build process. You do not need to back these up or commit them to a source code repository._
diff --git a/docs/walkthrough1.md b/docs/walkthrough1.md
@@ -80,7 +80,7 @@ You now have a fully working uibuilder configuration. However, it doesn't do any
 Now that you have the basics running, it is time to look at the front-end code. The important points to remember are:
 
 * The code is completely standard web code using HTML, CSS and JavaScript (and any libraries you might choose to use).
-* There is a JavaScript helper library that provides the magic connections between the front and back ends. See the technical docs for more information. A second library called `socket.io-client` is also loaded for you in the background, it enables the communications to/from Node-RED. The uibuilder client library will be one of: `uibuilder.iife.min.js` or `uibuilder.min.esm.min.js`. There is an older library, `uibuilderfe.min.js` but this is deprecated (as of uibuilder v6+) and should be replaced.
+* There is a JavaScript helper library that provides the magic connections between the front and back ends. See the documentation for more information. A second library called `socket.io-client` is also loaded for you in the background, it enables the communications to/from Node-RED. The uibuilder client library will be one of: `uibuilder.iife.min.js` or `uibuilder.min.esm.min.js`. There is an older library, `uibuilderfe.min.js` but this is deprecated (as of uibuilder v6+) and should be replaced.
 * All of the front-end code for a uibuilder node instance is stored in a single folder (with some pre-defined and any desired sub-folders).
 
 There are two ways to look at and change the content of an instance's root folder (which, remember, sits on the Node-RED server).

diff --git a/nodes/libs/web.js b/nodes/libs/web.js
@@ -167,7 +167,7 @@ class UibWeb {
          */
         const techDocsPath = path.join(__dirname, '..', '..', 'docs')
         this.adminRouter.use('/docs', express.static( techDocsPath, this.uib.staticOpts ) )
-        this.routers.admin.push( { name: 'Tech Docs', path: `${this.RED.settings.httpAdminRoot}uibuilder/docs`, desc: 'Documentation website powered by Docsify', type: 'Static', folder: techDocsPath } )
+        this.routers.admin.push( { name: 'Documentation', path: `${this.RED.settings.httpAdminRoot}uibuilder/docs`, desc: 'Documentation website powered by Docsify', type: 'Static', folder: techDocsPath } )
         this.adminRouter.use('/techdocs', express.static( techDocsPath, this.uib.staticOpts ) )
         this.routers.admin.push( { name: 'Tech Docs', path: `${this.RED.settings.httpAdminRoot}uibuilder/techdocs`, desc: 'Documentation website powered by Docsify', type: 'Static', folder: techDocsPath } )
 
@@ -514,7 +514,7 @@ class UibWeb {
          *   (3) Master static folders - for the built-in front-end resources (css, default html, uibuilderfe, etc)
          *   (4) [Optionally] The folder lister
          *   (5) Common static folder is last
-         * TODO Make sure the above is documented in Tech Docs
+         * TODO Make sure the above is documented in Docs
          */
 
         // (1.) Instance log route (./_clientLog)

diff --git a/nodes/uib-cache.html b/nodes/uib-cache.html
@@ -200,7 +200,7 @@
     A simple caching node that works with uibuilder.
 </p>
 <p>
-    See <a href="./uibuilder/techdocs/#/cache-node" target="_blank">Tech Docs: Using the cache node</a> for more detail.
+    See <a href="./uibuilder/techdocs/#/cache-node" target="_blank">Documentation: Using the cache node</a> for more detail.
 </p>
 
 <h3>Inputs</h3>
@@ -209,7 +209,7 @@ <h3>Inputs</h3>
 </p>
 <p>
     In addition, the node recognises uibuilder control messages for cache replay and cache clear.<br>
-    See <a href="./uibuilder/techdocs/#/pre-defined-msgs" target="_blank">Tech Docs: pre-defined messages</a> 
+    See <a href="./uibuilder/techdocs/#/pre-defined-msgs" target="_blank">Documentation: pre-defined messages</a> 
     for the structure of those messages.
 </p>
 

diff --git a/nodes/uib-sender.html b/nodes/uib-sender.html
@@ -138,7 +138,7 @@
     and a method of easily getting a response back again.
 </p>
 <p>
-    See <a href="./uibuilder/techdocs/#/sender-node" target="_blank">Tech Docs: Using the sender node</a> for more detail.
+    See <a href="./uibuilder/techdocs/#/sender-node" target="_blank">Documentation: Using the sender node</a> for more detail.
 </p>
 
 <h3>Inputs</h3>

diff --git a/src/editor/uib-cache/help.html b/src/editor/uib-cache/help.html
@@ -2,7 +2,7 @@
     A simple caching node that works with uibuilder.
 </p>
 <p>
-    See <a href="./uibuilder/techdocs/#/cache-node" target="_blank">Tech Docs: Using the cache node</a> for more detail.
+    See <a href="./uibuilder/techdocs/#/cache-node" target="_blank">Documentation: Using the cache node</a> for more detail.
 </p>
 
 <h3>Inputs</h3>
@@ -11,7 +11,7 @@ <h3>Inputs</h3>
 </p>
 <p>
     In addition, the node recognises uibuilder control messages for cache replay and cache clear.<br>
-    See <a href="./uibuilder/techdocs/#/pre-defined-msgs" target="_blank">Tech Docs: pre-defined messages</a> 
+    See <a href="./uibuilder/techdocs/#/pre-defined-msgs" target="_blank">Documentation: pre-defined messages</a> 
     for the structure of those messages.
 </p>
 
@@ -100,4 +100,4 @@ <h3>Node Settings</h3>
 <p>
     <b>NOTE</b> that there is an example flow in the examples library that demonstrates the use of this node.
     Use the Editor's menu, import, Examples, node-red-contrib-uibuilder and import the <code>uib-cache-test</code> example.
-</p>
+</p>
diff --git a/src/editor/uib-sender/help.html b/src/editor/uib-sender/help.html
@@ -3,7 +3,7 @@
     and a method of easily getting a response back again.
 </p>
 <p>
-    See <a href="./uibuilder/techdocs/#/sender-node" target="_blank">Tech Docs: Using the sender node</a> for more detail.
+    See <a href="./uibuilder/techdocs/#/sender-node" target="_blank">Documentation: Using the sender node</a> for more detail.
 </p>
 
 <h3>Inputs</h3>

diff --git a/templates/blank/src/index.js b/templates/blank/src/index.js
@@ -2,7 +2,7 @@
 
 /** The simplest use of uibuilder client library
  * Note that uibuilder.start() should no longer be needed.
- * See the Tech docs if the client doesn't start on its own.
+ * See the docs if the client doesn't start on its own.
  */
 'use strict'
 

diff --git a/templates/iife-blank-client/src/index.js b/templates/iife-blank-client/src/index.js
@@ -2,7 +2,7 @@
 
 /** Example of using the IIFE build of the uibuilder client library
  * Note that uibuilder.start() should no longer be needed.
- * See the Tech docs if the client doesn't start on its own.
+ * See the docs if the client doesn't start on its own.
  */
 'use strict'
 

diff --git a/templates/vue2-bootstrap/src/index.js b/templates/vue2-bootstrap/src/index.js
@@ -5,7 +5,7 @@
  *  with Vue and bootstrap-vue.
  *
  * Note that uibuilder.start() should no longer be needed.
- * See the Tech docs if the client doesn't start on its own.
+ * See the docs if the client doesn't start on its own.
  */
 
 // logLevel 2+ shows more built-in logging. 0=error,1=warn,2=info,3=log,4=debug,5=trace.

diff --git a/templates/vue2-simple/src/index.js b/templates/vue2-simple/src/index.js
@@ -2,7 +2,7 @@
 
 /** Example of using the IIFE build of the uibuilder client library with VueJS v2
  * Note that uibuilder.start() should no longer be needed.
- * See the Tech docs if the client doesn't start on its own.
+ * See the docs if the client doesn't start on its own.
  */
 'use strict'
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		Moved to the [Tech Docs roadmap page](https://totallyinformation.github.io/node-red-contrib-uibuilder/#/roadmap).
		Moved to the [Documentation roadmap page](https://totallyinformation.github.io/node-red-contrib-uibuilder/#/roadmap).