docs: update docs

noclocks · Mar 11, 2024 · c05b10e · c05b10e
1 parent 3d98ce2
commit c05b10e
Show file tree

Hide file tree

Showing 34 changed files with 568 additions and 6 deletions.
diff --git a/docs/about.md b/docs/about.md
@@ -0,0 +1,3 @@
+# About
+
+No Clocks, LLC is a software development company that specializes in creating custom software solutions for businesses. We are a team of experienced software developers who are passionate about creating high-quality software that meets the needs of our clients.
diff --git a/docs/assets/img/logo.png b/docs/assets/img/logo.png
diff --git a/docs/business/brand-kit.md → docs/business/design/brand-kit.md b/docs/business/brand-kit.md → docs/business/design/brand-kit.md
diff --git a/docs/business/design/index.md b/docs/business/design/index.md
diff --git a/docs/business/logo-config.md → docs/business/design/logo-config.md b/docs/business/logo-config.md → docs/business/design/logo-config.md
diff --git a/docs/business/business-expense-categories.md → ...ss/finance/business-expense-categories.md b/docs/business/business-expense-categories.md → ...ss/finance/business-expense-categories.md
diff --git a/docs/business/funding.md → docs/business/finance/funding.md b/docs/business/funding.md → docs/business/finance/funding.md
diff --git a/docs/business/finance/index.md b/docs/business/finance/index.md
@@ -0,0 +1 @@
+# Finance
diff --git a/docs/business/marketing-expenses.md → docs/business/finance/marketing-expenses.md b/docs/business/marketing-expenses.md → docs/business/finance/marketing-expenses.md
diff --git a/docs/business/pricing.md → docs/business/finance/pricing.md b/docs/business/pricing.md → docs/business/finance/pricing.md
diff --git a/docs/business/startup-costs.md → docs/business/finance/startup-costs.md b/docs/business/startup-costs.md → docs/business/finance/startup-costs.md
diff --git a/docs/business/legal/index.md b/docs/business/legal/index.md
diff --git a/docs/business/marketing/index.md b/docs/business/marketing/index.md
diff --git a/docs/business/checklist.md → docs/business/startup/startup-checklist.md b/docs/business/checklist.md → docs/business/startup/startup-checklist.md
diff --git a/docs/business/startup-notes.md → docs/business/startup/startup-notes.md b/docs/business/startup-notes.md → docs/business/startup/startup-notes.md
diff --git a/docs/business/startup-one-pager.md → docs/business/startup/startup-one-pager.md b/docs/business/startup-one-pager.md → docs/business/startup/startup-one-pager.md
diff --git a/docs/contact.md b/docs/contact.md
@@ -0,0 +1 @@
+# Contact
diff --git a/docs/dev/apis.md b/docs/dev/apis.md
diff --git a/docs/dev/cloud.md b/docs/dev/cloud.md
@@ -0,0 +1,22 @@
+# Cloud
+
+- Providers:
+  - [Azure](https://azure.microsoft.com/)
+  - [AWS](https://aws.amazon.com/)
+  - [GCP](https://cloud.google.com/)
+  - [Digital Ocean](https://www.digitalocean.com/)
+  - [Linode](https://www.linode.com/)
+  - [Fly.io](https://fly.io/)
+
+- Static Site Hosting:
+  - [GitHub Pages](https://pages.github.com/)
+  - [Vercel](https://vercel.com/)
+  - [Cloudflare Pages](https://pages.cloudflare.com/)
+  - [Netlify](https://www.netlify.com/)
+  - [Azure Static Web Apps](https://azure.microsoft.com/en-us/services/app-service/static/)
+  - [AWS S3](https://aws.amazon.com/s3/)
+  - [GCP Cloud Storage](https://cloud.google.com/storage)
+  - [Digital Ocean Spaces](https://www.digitalocean.com/products/spaces/)
+  - [Linode Object Storage](https://www.linode.com/products/object-storage/)
+  - [Fly.io](https://fly.io/)
+  - [Surge](https://surge.sh/)
diff --git a/docs/dev/containers.md b/docs/dev/containers.md
@@ -0,0 +1,6 @@
+# Containers
+
+- [Docker](https://www.docker.com/)
+- [Kubernetes](https://kubernetes.io/)
+- [Podman](https://podman.io/)
+- [Portainer](https://www.portainer.io/)
diff --git a/docs/dev/databases.md b/docs/dev/databases.md
@@ -0,0 +1,55 @@
+# Databases
+
+## Contents
+
+- [Databases](#databases)
+  - [Contents](#contents)
+  - [Overview](#overview)
+  - [PostgreSQL](#postgresql)
+  - [SQL Server](#sql-server)
+  - [MySQL](#mysql)
+  - [SQLite](#sqlite)
+
+
+## Overview
+
+No Clocks, LLC uses a variety of databases to store and manage data.
+
+Below is a list of databases we use:
+
+- [PostgreSQL](https://www.postgresql.org/)
+- [SQL Server](https://www.microsoft.com/en-us/sql-server/sql-server-2019)
+- [MySQL](https://www.mysql.com/)
+- [SQLite](https://www.sqlite.org/)
+
+## PostgreSQL
+
+PostgreSQL is a powerful, open-source object-relational database system. It is known for its reliability, robustness, and extensibility.
+
+No Clocks, LLC uses PostgreSQL for a variety of applications, including web applications, data analytics, and data warehousing.
+
+For more information about PostgreSQL, visit the [official website](https://www.postgresql.org/).
+
+## SQL Server
+
+SQL Server is a relational database management system developed by Microsoft. It is known for its scalability, security, and performance.
+
+No Clocks, LLC uses SQL Server for a variety of applications, including enterprise applications, business intelligence, and data warehousing.
+
+For more information about SQL Server, visit the [official website](https://www.microsoft.com/en-us/sql-server/sql-server-2019).
+
+## MySQL
+
+MySQL is an open-source relational database management system. It is known for its ease of use, performance, and scalability.
+
+No Clocks, LLC uses MySQL for a variety of applications, including web applications, content management systems, and e-commerce platforms.
+
+For more information about MySQL, visit the [official website](https://www.mysql.com/).
+
+## SQLite
+
+SQLite is a lightweight, embedded relational database management system. It is known for its simplicity, speed, and reliability.
+
+No Clocks, LLC uses SQLite for a variety of applications, including mobile applications, desktop applications, and embedded systems.
+
+For more information about SQLite, visit the [official website](https://www.sqlite.org/).
diff --git a/docs/dev/devops.md b/docs/dev/devops.md
@@ -0,0 +1,71 @@
+# DevOps
+
+No Clocks, LLC implements DevOps practices in all software projects. We use DevOps to automate software development, testing, and deployment processes.
+
+This document outlines our DevOps practices, including the tools we use, the CI/CD pipelines we implement, and the best practices we adhere to.
+
+## Contents
+
+- [DevOps](#devops)
+  - [Contents](#contents)
+  - [Overview](#overview)
+  - [CI/CD Pipelines](#cicd-pipelines)
+  - [References](#references)
+
+## Overview
+
+Below is a list of DevOps tools we use:
+
+- [GitHub Actions](https://github.com/docs/actions)
+- [Azure DevOps](https://azure.microsoft.com/en-us/services/devops/)
+
+along with the following tools:
+
+- [Docker](https://www.docker.com/)
+- [Kubernetes](https://kubernetes.io/)
+- [Terraform](https://www.terraform.io/)
+- [Helm](https://helm.sh/)
+
+We also use the following tools as necessary:
+
+- [Jenkins](https://www.jenkins.io/)
+- [CircleCI](https://circleci.com/)
+- [Travis CI](https://www.travis-ci.com/)
+- [Octopus Deploy](https://octopus.com/)
+- [GitLab CI/CD](https://docs.gitlab.com/ee/ci/)
+- [AWS CodePipeline](https://aws.amazon.com/codepipeline/)
+- [Google Cloud Build](https://cloud.google.com/cloud-build)
+- [Bitbucket Pipelines](https://bitbucket.org/product/features/pipelines)
+- [Spinnaker](https://spinnaker.io/)
+- [Argo CD](https://argoproj.github.io/argo-cd/)
+
+## CI/CD Pipelines
+
+No Clocks, LLC implements CI/CD pipelines in all software projects. We use CI/CD pipelines to automate the build, test, and deployment processes.
+
+We follow the following CI/CD practices:
+
+- Continuous Integration (CI): We use CI to automatically build and test code changes in a shared repository.
+- Continuous Deployment (CD): We use CD to automatically deploy code changes to production or staging environments.
+- Continuous Delivery (CD): We use CD to automatically deliver code changes to production or staging environments.
+- Infrastructure as Code (IaC): We use IaC to manage infrastructure resources in a declarative manner.
+- GitOps: We use GitOps to manage infrastructure and application configurations using Git repositories.
+- Blue-Green Deployment: We use Blue-Green Deployment to minimize downtime during software releases.
+- Canary Deployment: We use Canary Deployment to gradually roll out new features to a subset of users.
+- A/B Testing: We use A/B Testing to compare the performance of different versions of software.
+- Chaos Engineering: We use Chaos Engineering to test the resilience of software systems under stress.
+- Observability: We use Observability to monitor and analyze the behavior of software systems in real-time.
+- Security: We use Security best practices to protect software systems from vulnerabilities and attacks.
+- Compliance: We adhere to Compliance standards to ensure software systems meet regulatory requirements.
+- Performance: We optimize Performance to ensure software systems meet scalability and responsiveness goals.
+- Cost Optimization: We optimize Costs to ensure software systems are efficient and cost-effective.
+- Collaboration: We promote Collaboration between development, operations, and security teams to achieve common goals.
+- Automation: We automate repetitive tasks to improve efficiency and reduce errors in software development processes.
+- Monitoring: We monitor software systems to detect and resolve issues before they impact users.
+- Logging: We log events and errors to track the behavior of software systems and troubleshoot issues.
+- Alerting: We set up alerts to notify teams of critical issues and take immediate action to resolve them.
+- Incident Response: We have incident response plans in place to address and resolve incidents in a timely manner.
+
+## References
+
+- [The DevOps Handbook](https://itrevolution.com/book/the-devops-handbook/)
diff --git a/docs/dev/devx.md b/docs/dev/devx.md
@@ -0,0 +1 @@
+# Developer Experience
diff --git a/docs/dev/documentation.md b/docs/dev/documentation.md
diff --git a/docs/dev/frameworks.md b/docs/dev/frameworks.md
@@ -0,0 +1,60 @@
+# Frameworks
+
+No Clocks, LLC uses a variety of frameworks to build software solutions.
+
+Below is a (non-exhaustive) list of the frameworks we use:
+
+- Python:
+  - [Django](https://www.djangoproject.com/)
+  - [Flask](https://flask.palletsprojects.com/)
+  - [FastAPI](https://fastapi.tiangolo.com/)
+- R:
+  - [Shiny](https://shiny.rstudio.com/)
+  - [Plumber](https://www.rplumber.io/)
+- JavaScript:
+  - [React](https://reactjs.org/)
+  - [Remix](https://remix.run/)
+  - [Next.js](https://nextjs.org/)
+- .NET:
+  - [ASP.NET Core](https://docs.microsoft.com/en-us/aspnet/core/)
+  - [Blazor](https://dotnet.microsoft.com/apps/aspnet/web-apps/blazor)
+  - [Entity Framework Core](https://docs.microsoft.com/en-us/ef/core/)
+  - [Xamarin](https://dotnet.microsoft.com/apps/xamarin)
+  - [WPF](https://docs.microsoft.com/en-us/dotnet/desktop/wpf/)
+  - [WinForms](https://docs.microsoft.com/en-us/dotnet/desktop/winforms/)
+  - [PowerShell](https://docs.microsoft.com/en-us/powershell/)
+  - [Azure Functions](https://docs.microsoft.com/en-us/azure/azure-functions/)
+- CSS:
+  - [Tailwind CSS](https://tailwindcss.com/)
+  - [Bootstrap](https://getbootstrap.com/)
+  - [Bulma](https://bulma.io/)
+  - [Materialize](https://materializecss.com/)
+  - [Flexbox](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Flexible_Box_Layout/Basic_Concepts_of_Flexbox)
+  - [Fluent UI](https://developer.microsoft.com/en-us/fluentui)
+  - [Semantic UI](https://semantic-ui.com/)
+- ORM:
+  - [SQLAlchemy](https://www.sqlalchemy.org/)
+  - [Prisma](https://www.prisma.io/)
+- Testing:
+  - [pytest](https://docs.pytest.org/en/6.2.x/)
+  - [unittest](https://docs.python.org/3/library/unittest.html)
+  - [Jest](https://jestjs.io/)
+  - [React Testing Library](https://testing-library.com/docs/react-testing-library/intro/)
+  - [Cypress](https://www.cypress.io/)
+  - [RUnit](https://cran.r-project.org/web/packages/RUnit/index.html)
+  - [testthat](https://testthat.r-lib.org/)
+  - [NUnit](https://nunit.org/)
+  - [xUnit.net](https://xunit.net/)
+  - [MSTest](https://docs.microsoft.com/en-us/dotnet/core/testing/unit-testing-with-mstest)
+- Documentation:
+  - [Sphinx](https://www.sphinx-doc.org/)
+  - [MkDocs](https://www.mkdocs.org/)
+  - [Docusaurus](https://docusaurus.io/)
+  - [VuePress](https://vuepress.vuejs.org/)
+  - [DocFX](https://dotnet.github.io/docfx/)
+  - [Doxygen](https://www.doxygen.nl/index.html)
+  - [R Markdown](https://rmarkdown.rstudio.com/)
+  - [bookdown](https://bookdown.org/)
+  - [pkgdown](https://pkgdown.r-lib.org/)
+  - [blogdown](https://bookdown.org/yihui/blogdown/)
+  - [rmarkdown](https://rmarkdown.rstudio.com/)
diff --git a/docs/dev/iac.md b/docs/dev/iac.md
@@ -0,0 +1,23 @@
+# Infrastructure as Code
+
+- [Terraform](https://www.terraform.io/)
+- [Pulumi](https://www.pulumi.com/)
+- [Ansible](https://www.ansible.com/)
+
+## Azure
+
+- [Azure Resource Manager](https://docs.microsoft.com/en-us/azure/azure-resource-manager/)
+- [Azure Bicep](https://docs.microsoft.com/en-us/azure/azure-resource-manager/bicep/overview)
+- [Azure CLI](https://docs.microsoft.com/en-us/cli/azure/)
+- [Azure PowerShell](https://docs.microsoft.com/en-us/powershell/azure/)
+
+## AWS
+
+- [AWS CloudFormation](https://aws.amazon.com/cloudformation/)
+- [AWS CDK](https://aws.amazon.com/cdk/)
+
+## GCP
+
+- [Google Cloud Deployment Manager](https://cloud.google.com/deployment-manager)
+- [Google Cloud CLI](https://cloud.google.com/sdk)
+- [Google Cloud PowerShell](https://cloud.google.com/powershell)
diff --git a/docs/dev/languages.md b/docs/dev/languages.md
@@ -0,0 +1,40 @@
+# Languages
+
+No Clocks, LLC uses a variety of languages and frameworks to build software solutions. Below is a list of the languages and frameworks we use.
+
+## Contents
+
+- [Languages](#languages)
+  - [Contents](#contents)
+  - [Programming Languages](#programming-languages)
+
+## Programming Languages
+
+- [Python](https://www.python.org/)
+- [R](https://www.r-project.org/)
+- [HTML](https://html.spec.whatwg.org/)
+- [CSS](https://www.w3.org/Style/CSS/Overview.en.html)
+- [JavaScript](https://www.javascript.com/)
+- [TypeScript](https://www.typescriptlang.org/)
+- [Bash](https://www.gnu.org/software/bash/)
+- [PowerShell](https://docs.microsoft.com/en-us/powershell/)
+- [.NET](https://dotnet.microsoft.com/)
+- [VBA](https://docs.microsoft.com/en-us/office/vba/api/overview/)
+- [SQL](https://en.wikipedia.org/wiki/SQL)
+  - [PostgreSQL](https://www.postgresql.org/)
+  - [SQL Server](https://www.microsoft.com/en-us/sql-server/sql-server-2019)
+  - [MySQL](https://www.mysql.com/)
+  - [SQLite](https://www.sqlite.org/)
+- [Markdown](https://www.markdownguide.org/)
+- [YAML](https://yaml.org/)
+- [JSON](https://www.json.org/json-en.html)
+- [XML](https://www.w3.org/XML/)
+- [LaTeX](https://www.latex-project.org/)
+- [R Markdown](https://rmarkdown.rstudio.com/)
+- [Jupyter Notebooks](https://jupyter.org/)
+- [Dockerfile](https://docs.docker.com/engine/reference/builder/)
+- [Kubernetes YAML](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/)
+- [Terraform HCL](https://www.terraform.io/docs/language/syntax/configuration.html)
+- [Helm Charts](https://helm.sh/docs/topics/charts/)
+- [SQLAlchemy](https://www.sqlalchemy.org/)
+- [Prisma](https://www.prisma.io/)
diff --git a/docs/dev/os.md b/docs/dev/os.md
@@ -0,0 +1,6 @@
+# Operating Systems
+
+- [Linux](https://www.linux.org/)
+- [Windows](https://www.microsoft.com/en-us/windows)
+  - [WSL](https://docs.microsoft.com/en-us/windows/wsl/)
+- [macOS](https://www.apple.com/macos/)
diff --git a/docs/dev/ux.md b/docs/dev/ux.md
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# About

		No Clocks, LLC is a software development company that specializes in creating custom software solutions for businesses. We are a team of experienced software developers who are passionate about creating high-quality software that meets the needs of our clients.