Skip to content

Commit

Permalink
docs: add various md docs
Browse files Browse the repository at this point in the history
for #30
  • Loading branch information
jimbrig committed Mar 29, 2024
1 parent 8aa3a33 commit 08f2e3d
Show file tree
Hide file tree
Showing 5 changed files with 113 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/about.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# About
70 changes: 70 additions & 0 deletions docs/changelog.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
# Changelog

> All notable changes to this project will be documented in this file. The format is based on
[Keep a Changelog](http://keepachangelog.com/) and this project adheres to
[Semantic Versioning](http://semver.org/).

## [Unreleased]

### Bug Fixes

- Change testimonials to testimonial
- Fix typescript tripple slash directive
- Fix typo in dependabot.yml
- Fix records for mailchimp

### Configuration

- Add vscode spellilng dict
- Add creds.example.json to config/
- Fix LF
- Refactor path to types definition
- Migrate types to config folder

### Documentation

- Add techstack files
- Add docs/decisions files
- Add default docs/ files
- Add commands to examples
- Refactor README
- Add badges to README
- Add useful commands to README
- Update README table
- Update README
- Update DNS table in README
- Fix README

### Features

- Add new cname record for testimonials sub-domain
- Add new TXT records for Stripe and Vercel
- Add new CNAME records for Stripe
- Add medium A records
- Add vercel TXT verification
- Add custom stripe "pay" subdomain
- Add amazon verification TXT record
- Add shopify CNAME record
- Add google domain verification TXT
- Add TXT record for github domain verification
- Add new CNAME records
- Add `fmt` example output
- Add various example usage demos
- Add zone file export
- Add BIND type to creds
- Add slack webhook to creds
- Add TTLs
- Update DNS records with new email hosting records
- Add HubSpot blog DNS CNAME record
- Add changelog and pr mgmt

### Refactoring

- Refactor main dnsconfig
- Alter dnsconfig
- Cleanup
- Refactor dnsconfig

***
*Changelog generated by [git-cliff](https://github.com/orhun/git-cliff).*
***
16 changes: 16 additions & 0 deletions docs/contact.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Contact

## Email

- [dev@noclocks.dev](mailto:dev@noclocks.dev)

or individually:

- [Jimmy Briggs](mailto:jimmy.briggs@noclocks.dev)
- [Patrick Howard](mailto:patrick.howard@noclocks.dev)

## Social Media

- [GitHub](https://github.com/noclocks)
- [LinkedIn](https://www.linkedin.com/company/noclocks)
- [Twitter](https://twitter.com/noclocksdev)
25 changes: 25 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# No Clocks Domain Name System (DNS) Records

> This documentation outlines the system in place at [No Clocks, LLC](https://github.com/noclocks) for setting up, maintaining, managing, provisioning, and tracking the various *DNS records* we have set up for our domain: [noclocks.dev](https://noclocks.dev).
## Contents

## Navigation

- [Home](./index.md) (you are here)
- [Overview](./overview.md)
- [Tech Stack](./techstack.md)

- [DNS Records](./dns-records.md)
- [Email Aliases](./email-aliases.md)

- [About](./about.md)
- [Contact](./contact.md)

- [Changelog](./changelog.md)

## Architecture Decision Records (ADRs)

- [001: Porkbun](./decisions/001-porkbun.md)
- [002: DNSControl vs. Terraform](./decisions/002-dnscontrol-vs-terraform.md)
- [003: Docker](./decisions/003-docker.md)
1 change: 1 addition & 0 deletions docs/overview.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Overview

0 comments on commit 08f2e3d

Please sign in to comment.