wip

Author: ais-one

.github/CONTRIBUTING.md

@@ -1,15 +1,15 @@
-# VueCrudX Contributing Guide
-Hello and thank you for your interest in helping make VueCrudX better. Please take a few moments to review the following guidelines:
+# cookbook Contributing Guide
+Hello and thank you for your interest in helping make cookbook better. Please take a few moments to review the following guidelines:
 
 ## IMPORTANT INFORMATION
-* For general questions, please join [TBD - our Discord Community](https://community.TBD.com/).
+* For general questions, please join [Our Discussion Board](https://github.com/ais-one/cookbook/discussions).
 
 ## Reporting Issues
 * The issue list of this repo is **exclusively** for Bug Reports and Feature Requests.
 * Bug reproductions should be as **concise** as possible.
 * **Search** for your issue, it _may_ have been answered.
 * See if the error is **reproduceable** with the latest version.
-* If reproduceable, please provide a [Codepen](https://template.tbd.com) or public repository that can be cloned to produce the expected behavior. It is preferred that you create an initial commit with no changes first, then another one that will cause the issue. 
+* If reproduceable, please provide a [Codepen](https://codepen.io/) or public repository that can be cloned to produce the expected behavior. It is preferred that you create an initial commit with no changes first, then another one that will cause the issue. 
 * **Never** comment "+1" or "me too!" on issues without leaving additional information, use the :+1: button in the top right instead.
 
 ## Pull Requests

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,8 +1,5 @@
 ### Please read and mark the following check list before creating a pull request (check one with "x"):
 
- - [ ] I read and followed the [Contribution guide](https://github.com/ais-one/cookbook/blob/master/.github/CONTRIBUTING.md)
- <!-- TBD
- - [ ] I read and followed the [New Feature Checklist](https://github.com/ais-one/cookbook/blob/master/.github/DEV_DOCS.md#new-feature-checklist)
--->
+ - [ ] I read and followed the [Contribution guide](https://github.com/ais-one/cookbook/blob/main/.github/CONTRIBUTING.md)
 
  #### Short description of what this resolves:

CHANGELOG.md

@@ -250,7 +250,7 @@
   - set our internal usage key to __key, to avoid collisions
   - hide = hide table
   - filter & sort is not enabled by default, need to set as true
-- [common-lib/esm/bwc-t4t-form.js] - (generic crud) create form using web components - currently only input tag handled (TBD add select tag, and other custom tags, handle file inputs)
+- [common-lib/esm/bwc-t4t-form.js] - (generic crud) create form using web components - currently only input tag handled (TODO add select tag, and other custom tags, handle file inputs)
 - [common-lib/esm/t4t-fe.js] - (generic crud) created utilities also includes validation...
 - [common-lib/esm/t4t-validate.js] - (generic crud) created validation for backend use
 - [example-vite] NOTE: mwc-multiselect.js is broken

README.md

@@ -6,42 +6,38 @@
 [![Known Vulnerabilities](https://snyk.io/test/github/ais-one/cookbook/badge.svg)](https://snyk.io/test/github/ais-one/cookbook)
 [![MadeWithVueJs.com shield](https://madewithvuejs.com/storage/repo-shields/823-shield.svg)](https://madewithvuejs.com/p/cookbook/shield-link)
 
-## IMPORTANT - Read Me First!
+### 1 - IMPORTANT - Read Me First!
 
-### 1 - Updateable Templates
+### 1.1 - Updateable Templates
 
 Your project is created using a template. If template has updates, can the upstream changes be managed with minimal impact on userland codes?
 
-Yes and our project achieve this through:
-
+Yes and this is achieved through:
 - Design
-  - Exclude configurable files from repo (e.g. .env), but include sample (e.g. .env.sample) for reference
   - Create folder where all userland code is placed, template must NOT touch this folder
+  - template should not to be part of a monorepo 
 - Process
-  - clone template repo
-  - create a remote called `upstream` pointing to template repo
+  - clone template and create remote called `upstream` pointing to template
   - update framework when necessary by merging `upstream` into `origin`
 
-Updateable template should not to be part of a monorepo
-
-### 2 - Manageable Sharing
+### 1.2 - Manageable Sharing
 
 You have code shared between multiple projects and libraries. If the code is updated. Can you avoid breaking your dependents and dependencies?
 
-Yes, by basing on the following principles
+Yes, based on the following principles:
 - Shared libraries should be isolated and versioned, dependents can stay on last-known-good version and update when ready
 - Isolation and versioning can be extended to `types` (for Typescript) and `contracts` (for API)
 - minimize inter & nested dependencies, and technical debt
 
 ---
 
-### 3 - General Requirements
+### 2 - General Requirements
 
 - git, github (for actions, secrets, etc) & IDE (e.g. vscode), Docker
-- use unix shell (Windows use git-bash or WSL2)
+- unix shell (Windows use git-bash or WSL2)
 - node 18+ LTS & npm 9+ (npm i -g npm@latest `to update`)
 
-### 4 - Recipies
+### 3 - Recipies
 
 [Projects](recipies/README.md) that can be used (express and vuejs template, shareable libraries and tools)
 
@@ -77,19 +73,19 @@ Yes, by basing on the following principles
 
 ---
 
-### 5 - Sandbox
+### 4 - Sandbox
 
 Research and exploration [projects](sandbox/README.md)
 
-### 6 - Docker Dev Env
+### 5 - Docker Dev Env
 
 Container setups for supporting apps for local development and testing [docker-devenv/README.md]()
 
-### 7 - Documentation
+### 6 - Documentation
 
-The [docs](docs/home.md) folder contains documentation on other related/unrelated topics and is in the midst of a major update
+The [docs](docs/home.md) folder contains useful information is in the midst of a major cleanup
 
-### 8 - Useful scripts - For Use By Maintainers
+### 7 - Useful scripts - For Use By Maintainers
 
 - `bulk-git.sh`: script to diff, pull, push git (for repos in `recipies`)
 - `bulk-npm.sh`: script to check for and/or update dependencies in package.json (for repos in `recipies`)

docs/cloud.md

@@ -2,7 +2,7 @@
 
 Where GCP, AWS, Azure Aliyun, Most concepts are the same
 
-Try to use terraform (TBD refer to DSO project)
+Try to use terraform (TODO refer to DSO project)
 
 ## Install CLI
 

docs/deployment.md

@@ -433,7 +433,7 @@ docker exec -it <container id> /bin/bash
 # to save an image
 docker save image:tag | gzip > image-tag.tar.gz
 
-# TBD load an image from tar.gz
+# TODO load an image from tar.gz
 ```
 
 ## Docker Commands

docs/js.md

@@ -138,7 +138,7 @@ Bind is different. It always returns a new function. We can use Bind to curry fu
 
 ### Classes / Prototypes
 
-TBD
+TODO
 
 ## Scope
 

docs/nodejs.md

@@ -183,4 +183,4 @@ You need to create `tag` on the github remote also by creating a new release or
 
 - https://blog.logrocket.com/optimize-node-js-performance-with-clustering/
 - https://blog.logrocket.com/customizing-node-js-env-files/
-- TBD workerthreads
+- TODO workerthreads

docs/sqa-nodejs.md

@@ -108,11 +108,11 @@ pre-commit sample file is created in .husky/pre-commit
 
 ## commitizen
 
-TBD
+TODO
 
 ## semantic version
 
-TBD
+TODO
 
 # A list of Software Quality Assurance Tools
 

recipies/README.md

@@ -22,6 +22,6 @@ The packages in the `libs` workspace are published to npm. They are shared, vers
 The packages in `tools` workspace contain the following useful sample applications
 - dbdeploy: for DB migration and seeding
 
-### 4 [ReactJS Template - TBD]()
+### 4 [ReactJS Template - TODO]()
 
 

sandbox/aws/index.ts

@@ -75,7 +75,7 @@ export const readFile = async (keyName: string | undefined) => {
     Key: keyName,
   });
 
-  // TBD try and promisify
+  // TODO try and promisify
   try {
     const response = await client.send(command);
     const input: SdkStream<any> | undefined = response.Body

sandbox/services/README.md

@@ -71,7 +71,7 @@ See output when sending message from a client (currently client that sent will a
 
 If going through a proxy such as load balancer, need sticky sessions
 
-TBD: handle duplicate message to message originator client on subscription message
+TODO: handle duplicate message to message originator client on subscription message
 
 
 ---