Skip to content

Commit

Permalink
updates
Browse files Browse the repository at this point in the history
Signed-off-by: Raj Patil <rajp152k@gmail.com>
  • Loading branch information
rajp152k committed Jan 7, 2025
1 parent 98c592a commit efddada
Show file tree
Hide file tree
Showing 13 changed files with 73 additions and 44 deletions.
2 changes: 2 additions & 0 deletions Content/20231227155636-development.org
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@
#+filetags: :meta:programming:

* Major Index
** Google best practices
- https://google.github.io/eng-practices/
** Dependencies
:PROPERTIES:
:ID: 4a17f01a-8000-40d0-bf4d-46da6cdacc1d
Expand Down
42 changes: 7 additions & 35 deletions Content/20240219144517-system_design.org
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,8 @@
#+title: System Design
#+filetags: :cs:

* Abstract

This node cluster references all the technicalities that go into designing a system - this should as a good rounded tour of the practical aspects of computer science.

An important aspect of system design is to be able to handle all the users that interact with the system. This usually calls for [[id:a3d0278d-d7b7-47d8-956d-838b79396da7][Distributed Systems]]

System design is a problem oriented and not just limited to generical theoretical design patterns.

* Major Aspects
** Scalability
:PROPERTIES:
:ID: 56dbce77-b258-4fde-a6c7-f865e476c879
:END:
** [[id:56dbce77-b258-4fde-a6c7-f865e476c879][Scalability]]
- the ability of a system to continue to behave as expected in the face of significant upward or downward changes in demand.
*** Types
**** Vertical Scaling
Expand All @@ -29,37 +18,20 @@ System design is a problem oriented and not just limited to generical theoretica
- have services with their state management decoupled from the act of serving.
- see [[id:a3d0278d-d7b7-47d8-956d-838b79396da7][Distributed Compute]] i.e. distributing state between service replicas.

** Loose Coupling
:PROPERTIES:
:ID: adaf5bfa-48f9-415b-893e-7398b10f383e
:END:
** [[id:adaf5bfa-48f9-415b-893e-7398b10f383e][Loose Coupling]]
- the system property and design strategy in which a system's components have minimal knowledge of any other components.
- internal changes to one don't demand changes in the other
- web servers and web browsers for instance are loosely coupled given both have certain guarantees.
*** Enablement
- Having a [[id:11d303f1-d337-4f51-b211-db435a9f2cd0][Protocol]] allows standardizing the input expectations and output assurances of a component.
- These may be addressed as [[id:11d303f1-d337-4f51-b211-db435a9f2cd0][Interfaces]] as well.
** Resilience
:PROPERTIES:
:ID: b24fb743-99bb-4e1a-b4a4-3b81c9677360
:END:
- see [[id:20240519T162542.805560][fault tolerence]]
** [[id:b24fb743-99bb-4e1a-b4a4-3b81c9677360][Resilience]]
- see also [[id:20240519T162542.805560][fault tolerence]]
- the measure of how well a system withstands and recovers from errors and faults

** Manageability
:PROPERTIES:
:ID: 2cd51b23-f253-40e2-8c5d-6f2924ca484d
:END:
** [[id:2cd51b23-f253-40e2-8c5d-6f2924ca484d][Manageability]]
- the ease with which a system's behaviour can be modified to keep it secure, running smoothly, and compliant with changing requirements.
** Observability
:PROPERTIES:
:ID: 3913909e-2b8d-465c-8303-5c634bd08f57
:END:
** [[id:3913909e-2b8d-465c-8303-5c634bd08f57][Observability]]
- the measure of how well a system's internal states can be inferred from knowledge of its external outputs.
* Quick Links
** Latency numbers every programmer should know
:PROPERTIES:
:ID: 2dca77bf-c105-407f-8afc-289716ea79d5
:END:
- https://colin-scott.github.io/personal_website/research/interactive_latency.html
- https://www.youtube.com/watch?v=FqR5vESuKe0&list=PLCRMIe5FDPsd0gVs500xeOewfySTsmEjf&index=3&ab_channel=ByteByteGo
** [[id:2dca77bf-c105-407f-8afc-289716ea79d5][Latency numbers every programmer should know]]
1 change: 1 addition & 0 deletions Content/20240426173703-etcd.org
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,4 @@ Auxiliary features worth noting:
- [[https://www.consul.io/][Hashicorp Consul]]
* Resources
- https://learnk8s.io/etcd-kubernetes
- https://etcd.io/docs/v3.6/quickstart/
4 changes: 2 additions & 2 deletions Content/20240519162542-fault_tolerence.org
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
:PROPERTIES:
:ID: 20240519T162542.805560
:END:
#+title: fault tolerence
#+filetags: :cs:
#+title: Fault Tolerence
#+filetags: :eng:cs:

Also see [[id:45753302-58fd-4cb1-bff6-f8843aee5708][Chaos Engineering]]

Expand Down
11 changes: 4 additions & 7 deletions Content/20241023131919-aritificial_intelligence.org
Original file line number Diff line number Diff line change
@@ -1,13 +1,10 @@
:PROPERTIES:
:ID: db649cb6-047e-426e-8cdc-774586ef30a0
:ROAM_ALIASES: AI
:END:
#+title: Artificial Intelligence
#+filetags: :ai:

* Stream
** 0x22F4
- the [[id:3504d497-477f-467c-8d6b-d8096c7528c1][Data Science Hierarchy of Needs]]
** 0x22EC
- going for a pragmatic rediscovery of aspects of the field that can be applied to other domains
- have an academic foundation that could be leveraged into directing miscellaneous research streams
- this is a generic node for relevant applications could be applied anywhere based on how one frames the domain specific problem.

* Resources
- https://ai.openbestof.com/
1 change: 1 addition & 0 deletions Content/20241218184944-mcp.org
Original file line number Diff line number Diff line change
Expand Up @@ -20,3 +20,4 @@
- https://llmindset.co.uk/posts/2024/12/mcp-build-notes/
- https://github.com/punkpeye/awesome-mcp-servers/
- https://llmindset.co.uk/posts/2024/12/mcp-build-notes/
- https://mcpserver.cloud/
22 changes: 22 additions & 0 deletions Content/20250103193241-openapi.org
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
:PROPERTIES:
:ID: a5fc0eca-58cc-4cde-9ae8-4e22fa7f57f3
:END:
#+title: OpenAPI
#+filetags: :protocol:cs:programming:

* Overview

- *Definition*: OpenAPI is a specification for building [[id:20240101T073142.439145][APIs]] using a standard format which provides a clear structure for describing [[id:88828c6f-87e0-4569-b236-dc6ebb72d282][RESTful]] web services.
- *Purpose*: It allows both humans and computers to discover and understand the capabilities of a service without requiring access to the source code, enabling easier integration and documentation.
- *Key Components*:
- *Paths*: Defines the endpoints in the API and how they interact.
- *Operations*: Specifies the HTTP methods used (GET, POST, PUT, DELETE, etc.).
- *Parameters*: Outlines input parameters and their descriptions.
- *Responses*: Describes the output returned by the API, including status codes and message content.
- *Schemas*: Defines the data structures used in input/output for stronger validation and clarity.
- *Format*: Typically written in YAML or JSON.
- *Interoperability*: Facilitates collaboration between diverse teams and different tooling ecosystems by establishing a universal
* [[id:f6f7f087-b7fe-4192-8950-497166f5af0f][MCP]]
- https://www.mcpservers.ai/servers/snaggle-ai/OpenAPI
* Resources
- https://www.openapis.org/what-is-openapi
5 changes: 5 additions & 0 deletions Content/20250107095920-scalability.org
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
:PROPERTIES:
:ID: 56dbce77-b258-4fde-a6c7-f865e476c879
:END:
#+title: Scalability
#+filetags: :eng:cs:
5 changes: 5 additions & 0 deletions Content/20250107100029-loose_coupling.org
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
:PROPERTIES:
:ID: adaf5bfa-48f9-415b-893e-7398b10f383e
:END:
#+title: Loose Coupling
#+filetags: :eng:cs:
5 changes: 5 additions & 0 deletions Content/20250107100239-resilience.org
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
:PROPERTIES:
:ID: b24fb743-99bb-4e1a-b4a4-3b81c9677360
:END:
#+title: Resilience
#+filetags: :eng:cs:
5 changes: 5 additions & 0 deletions Content/20250107100315-manageability.org
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
:PROPERTIES:
:ID: 2cd51b23-f253-40e2-8c5d-6f2924ca484d
:END:
#+title: Manageability
#+filetags: :eng:cs:
5 changes: 5 additions & 0 deletions Content/20250107100348-observability.org
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
:PROPERTIES:
:ID: 3913909e-2b8d-465c-8303-5c634bd08f57
:END:
#+title: Observability
#+filetags: :eng:cs:
9 changes: 9 additions & 0 deletions Content/20250107100837-latency_index.org
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
:PROPERTIES:
:ID: 2dca77bf-c105-407f-8afc-289716ea79d5
:END:
#+title: Latency Index
#+filetags: :eng:cs:

* Resources
- https://colin-scott.github.io/personal_website/research/interactive_latency.html
- https://www.youtube.com/watch?v=FqR5vESuKe0&list=PLCRMIe5FDPsd0gVs500xeOewfySTsmEjf&index=3&ab_channel=ByteByteGo

0 comments on commit efddada

Please sign in to comment.