Skip to content

Instantly share code, notes, and snippets.

View briandominick's full-sized avatar
💭
Available for DocOps contracts

Brian Dominick briandominick

💭
Available for DocOps contracts
  • Catskill Mountains, NY
View GitHub Profile
@briandominick
briandominick / README.adoc
Last active November 1, 2024 22:24
OpenPathY: A YAML-sourced schema for modeling, validating, and documenting filesystem/codebase paths

Imagine a schema for defining expected directory/file structures for your applications.

Define it all in YAML, then use a proper library to:

  • validate an existing path structure against your schema

  • generate model folder/file trees in arbitrary or logical order

  • document your expected path structure based on properties of each dir/file key

Take a look at the following example schema.

{
"Pet": {
"type": "object",
"required": [
"name",
"photoUrls"
],
"properties": {
"id": {
"type": "integer",
@briandominick
briandominick / bibisco-install-ubuntu.adoc
Created October 6, 2019 23:49
Install Bibisco on Ubuntu 19.04

Setting up Bibisco on Ubuntu 19.04

(tested on PopOS 19.04)

  1. Download linux archive from Bibisco.

  2. Move files to better path.

    sudo mv ~/Downloads/bibisco-blah-blah/ ~/opt/bibisco
@briandominick
briandominick / fusuma-config.yml
Created August 26, 2019 04:31
Configuration file for fusuma touchpad gestures
# Fusuma makes Linux touchpads better
# See https://github.com/iberianpig/fusuma
swipe:
3:
left:
command: 'xdotool key alt+Right'
right:
command: 'xdotool key alt+Left'
up:
command: 'xdotool key super'
@briandominick
briandominick / Jekyll Build Scripts
Last active February 8, 2020 01:10
An environment- and version-aware command-line wrapper for Jekyll builds
# See README.adoc
@briandominick
briandominick / Jekyll Version Switcher
Last active March 3, 2022 05:29
Versioning system for Jekyll
See README.adoc
@briandominick
briandominick / doc-ops-consulting-agreement.adoc
Last active July 19, 2022 17:29
Sample DocOps Consulting Agreement (Prime Source)

Documentation Engineering Consulting Agreement

@briandominick
briandominick / ajyl-docstack-intro.adoc
Last active April 22, 2020 16:03
Introducing the AJYL Docstack

AJYL DocStack

AsciiDoc

Jekyll

@briandominick
briandominick / asciidoc-static.adoc
Last active November 21, 2024 11:12
Static Site Generators with AsciiDoc Support

There are 28 static site generators that support AsciiDoc sourcing.

@briandominick
briandominick / _built_config-explainer.adoc
Created February 23, 2018 03:24
A programmatically generated narrative of a preconfigured build operation in LiquiDoc.
  1. Copies content/ to _build/, without carrying the parent directory.

  2. Copies theme/ to _build/.

  3. Performs the first round of product-data parsing to build two structurally vital files, sourcing data in data/product.yml.

    1. Builds the page metadata (_build/includes/_built_page-meta.adoc) included in all HTML and PDF exposures of topics, but only relevant as Jekyll page metadata at this time.

    2. Builds the metadata file _build/includes/_built_page-meta.adoc based on the user stories in product.yml, looping over them as directed in _templates/liquid/page-meta.asciidoc. The topics metadata is drawn from this preprocessed file (_build_page-meta.adoc).

  4. Draws data from the `data/meta.yml`and parses it as follows:

    1. Builds _build/includes/_built_company-info.adoc pressed with the template _templates/liquid/company-info.asciidoc.

  5. Draws data from the `data/terms.yml`and parses it as follows: