ikane

Overview

How to document a new codebase

Use this template to document a new codebase.

Business Logic

A place to record any important logic that you come across that is worth documenting.

Landmarks

Refers to the different landmarks of a codebase to help you navigate around. Where are the API methods defined? Where are interactions with the database?

ikane

#! /bin/bash

# ECHO COMMAND
# echo Hello World!

# VARIABLES
# Uppercase by convention
# Letters, numbers, underscores
NAME="Bob"
# echo "My name is $NAME"

ikane

{
	"info": {
		"_postman_id": "0b02fd94-70ce-4cb2-a0b6-1fb45cadbf17",
		"name": "Send Event to EventHub",
		"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
	},
	"item": [
		{
			"name": "Get Access Token for sending Event",
			"event": [

ikane

let sampleObj = {
    name: "Mark",
    occupation: "Developer"
};
let emptyObj = {};
console.log(Object.entries(sampleObj).length === 0); // false
console.log(Object.entries(emptyObj).length === 0); // false

ikane

const person = {
    name: "Mark",
    username: "@markcodes"
};
// Using Object.assign() Method
const clonePerson1 = Object.assign({}, person);
// Using JSON
const clonePerson2 = JSON.parse(JSON.stringify(person));
// Using Spread Operator
const clonePerson3 = { ...person };

ikane

[alias]
	co = checkout
	cob = checkout -b
	coo = !git fetch && git checkout
	br = branch
	brd = branch -d
	brD = branch -D
	merged = branch --merged
	st = status
	aa = add -A .

ikane

curl localhost:9200/get-together/_settings?pretty.

ikane

GET order_index/_search
{
  "query": {
    "bool": {
      "filter": [
        {
          "match": {
            "orderCategory":"DRIVE"
          }
        }

ikane

DENORMALIZE DOCUMENT
--------------------
MERGE INTO test as countries
USING test as regions
ON countries.regionCode=regions.code AND regions.`_class`="Region" and countries.`_class`="Country"
WHEN MATCHED THEN
 UPDATE SET countries.regionName = regions.name
 
 ********* couchebase 6.0 *******
  UPDATE oms st SET st.warehouseName = 

ikane

[ 
  {name: 'Afghanistan', code: 'AF'}, 
  {name: 'Åland Islands', code: 'AX'}, 
  {name: 'Albania', code: 'AL'}, 
  {name: 'Algeria', code: 'DZ'}, 
  {name: 'American Samoa', code: 'AS'}, 
  {name: 'AndorrA', code: 'AD'}, 
  {name: 'Angola', code: 'AO'}, 
  {name: 'Anguilla', code: 'AI'}, 
  {name: 'Antarctica', code: 'AQ'},