Writing Styleguide

Article Structure

Header

Footer

  • Thanks
  • Related Material

Technical Pieces

Assumptions

Series

  • Document at the beginning of each series all previous posts in the series
  • At the conclusion of the series, create a review piece that summarises the series and experiences, and links all of the relevant pages.

Tutorials / Debugging

File Snippets

# etc/fleet/config.yml:48-54foo:
bar: "baz"
$ cat /etc/passwd
# /dev/stdout:1-2root:x:0:0:root:/root:/bin/bash

Process Output

$ kubectl describe pod kolide-fleet-fleet-56b5c7f7c9-gkwpl #15-16,31-33...
Containers:
fleet:
...
Requests:
cpu: 100m
memory: 256Mi
...
  • The output has been truncated, which we express with ...
  • The command has been suffix # ${START}-${END},${START}-${END} leaving it syntactically valid, but descriptive

Code

Bash

$ cat /dev/null

Software

  • I use jq to navigate JSON blobs
  • I use vim over nano or emacs as the one true editor

Distribution

Scheduled

  • Buffer (Twitter, Facebook)
  • LinkedIn (Full Article)
  • Telling your mum

Indexed

References

--

--

See https://www.andrewhowden.com/

Love podcasts or audiobooks? Learn on the go with our new app.

Get the Medium app

A button that says 'Download on the App Store', and if clicked it will lead you to the iOS App store
A button that says 'Get it on, Google Play', and if clicked it will lead you to the Google Play store