search

jeffersonroth / jjrf-data-reliability-book

Data Reliability Book
MIT License
0 stars 0 forks source link

readme


Logo

Data Reliability Engineering

Book about data reliability engineering, data quality, and data architecture.

Preview

Table of Contents
  1. Getting Started
  2. Development
  3. Dependencies
  4. License
  5. Contact

Getting Started

  1. Clone the repo

    git clone https://github.com/jeffersonroth/jjrf-data-reliability-book.git

  2. Serve the book locally

    docker compose up

  3. Check the rendered book in localhost

Development

Before pushing your local branch:

  1. Generate SVG files from the PlantUML diagrams and save them to assets.

  2. Review the content in localhost

  3. Run linters

    markdownlint-cli2 --config ./.github/files/config.markdownlint-cli2.jsonc --fix | tee mdlint

  4. Run link checkers

    find . -name \*.md -print0 | xargs -0 -n1 markdown-link-check --config ./.github/files/markdown.links.config.json | tee mdlink

Dependencies

mdBook Environment Docker Image

Personal Docker image I use to build the book in html.

mdBook Environment Dev Docker Image

Personal Docker image with mdBook devtools.

mdBook Plugins

mdBook plugins to generate table of contents, render Mermaid diagrams, etc.

Math Jax

Enable writing mathematical formulae in markdown format.

Markdown Linter

CLI tool to check and apply lint rules in markdown files.

Markdown Links Check

CLI tool to validate all hyperlinks in markdown files.

Hand-drawn SVG Style

Tool that applies different hand-drawn styles to SVG files. This project uses Ballpoint pen style.

PlantUML to SVG

Tool that convert PlantUML code in SVG format.

Mermaid

Mermaid diagrams.

Unicode Characters

Use Unicode Characters in hexadecimal: Ⓐ = \Ⓐ.

Emojicodes

Use valid emojicodes: :fire: = :fire\:.

License

Copyright (C) 2021 Jefferson Johannes Roth Filho. See LICENSE for more information.

Contact

Jefferson Roth - jjrothfilho@gmail.com

Project Link: https://github.com/jeffersonroth/jjrf-data-reliability-book