Commit 6fced2e8 authored by Jamie Tanna's avatar Jamie Tanna

Standardise on `blogumentation` tag/category

Instead of it being done via `findings`, we should follow the term
`blogumentation` and ensure we're making it obvious for viewers of the
site.

This is important because so many views on the site click through to
`/tags/blogumentation/` or `/categories/blogumentation/`, but that
doesn't catch much.

Closes #207.
parent 88b38348
Pipeline #21309089 passed with stages
in 8 minutes
......@@ -3,7 +3,7 @@ layout: post
title: Downloading log files over SSH when your log aggregation service doesn't work
description: '**Without making changes to the files themselves**'
categories:
tags: break-glass logs ssh findings shell tips
tags: break-glass logs ssh blogumentation shell tips
---
## Context
......
......@@ -2,8 +2,8 @@
layout: post
title: Cleaning Up Your LaTeX Build Output with `latexrun`
description: A tool to help reduce the amount of unnecessary output when building LaTeX files.
categories: findings
tags: findings latex tools workflow
categories: blogumentation
tags: blogumentation latex tools workflow
---
## Where We Are Now
......
......@@ -2,7 +2,7 @@
layout: post
title: Saving Repetition with Git Commit Templates
description: Speed up your commit message writing by providing a template for when you run `git commit`.
categories: findings
categories: blogumentation
tags: tools git workflow automation
---
## Creating Your Commit Template
......
......@@ -2,8 +2,8 @@
layout: post
title: glances, a `top` and `htop` replacement
description: I share the tool I have been using for system utilisation and monitoring, `glances`.
categories: findings
tags: findings cli python tool workflow
categories: blogumentation
tags: blogumentation cli python tool workflow
no_toc: true
---
[`glances`][glances] is a command-line Python tool, which looks to replace tools such as [`top`][top], [`htop`][htop], and [`iotop`][iotop], with a little bit of [`ctop`][ctop].
......
......@@ -2,7 +2,7 @@
layout: post
title: Extracting SSL/TLS Certificate Chains Using OpenSSL
description: A quick one-liner to get you the full certificate chain in `.pem` format.
categories: findings
categories: blogumentation
tags: bash shell oneliner openssl certificates
no_toc: true
---
......
......@@ -3,7 +3,7 @@ layout: post
title: Building Chef Cookbooks with GitLab (Part 1)
description: An introduction to how to build a cookbook using GitLab's Continuous Integration platform in conjunction with `kitchen-docker`.
categories: guide chef gitlab
tags: howto findings gitlab chef test-kitchen docker gitlab-ci
tags: howto blogumentation gitlab chef test-kitchen docker gitlab-ci
image: /assets/img/vendor/chef-logo.png
---
......
......@@ -2,7 +2,7 @@
layout: post
title: Viewing your diff while writing your commits with git commit --verbose
description: Making it easier to write commit messages by having the diff in your editor.
categories: findings
categories: blogumentation
tags: git commit shell workflow
---
I am a firm believer of the fact that Git history should be documentation for the reasoning behind _why_ the code is as it is. As such, I take care to make my commits follow [Chris Beams' commit guidelines][git-commit], which usually involves writing the commit while reading the diff of what's changed, so I don't forget anything.
......@@ -63,7 +63,7 @@ index 0000000..03deabc
+layout: post
+title: `git commit --verbose`
+description: Viewing your diff while writing your commits.
+categories: findings
+categories: blogumentation
+tags: git commit shell
+---
+My common workflow for writing about a commit is either to do something like:
......
......@@ -2,8 +2,8 @@
layout: post
title: Pretty Printing JSON on the Command Line with Python
description: Using Python's JSON module to pretty print JSON objects from the command line.
categories: findings
tags: findings python json
categories: blogumentation
tags: blogumentation python json
no_toc: true
---
You may often find yourself on a command-line, for instance when SSH'd into a server, and need to read some JSON. This could be a JSON configuration file, or indeed it could be simply a response from an API endpoint.
......
......@@ -2,8 +2,8 @@
layout: post
title: Clean up your Git branches
description: Remove any merged local or branches from your local Git repository
categories: findings
tags: findings git
categories: blogumentation
tags: blogumentation git
---
## Intro
......@@ -38,7 +38,7 @@ revert-dda5c692
This means that whenever I'm trying to use my tab completion, I have a load of options to scroll through, which is a less than ideal user experience as it increases the number of characters needed to type before a branch can be autocompleted. To this end, I've recently been looking at how to clean up the number of branches I have.
Each time I've [DuckDuckGo'd][ddg] the commands, the last time of which made me think I should document it somewhere that I can easily browse to in future. And in the light of wanting to [document my findings for everyone to consume][blog-as-documentation], I've rolled it into a blog post.
Each time I've [DuckDuckGo'd][ddg] the commands, the last time of which made me think I should document it somewhere that I can easily browse to in future. And in the light of wanting to [document my blogumentation for everyone to consume][blog-as-documentation], I've rolled it into a blog post.
## Removing Local Checked-Out Branches
......
......@@ -2,8 +2,8 @@
layout: post
title: Converting YAML to JSON and vice versa (Part 1 - Ruby)
description: Coerce YAML to JSON and vice versa, from the comfort of your Gem-studded command line.
categories: findings
tags: findings ruby cli
categories: blogumentation
tags: blogumentation ruby cli
---
I've recently been finding myself trying to coerce YAML to JSON and vice versa quite a bit, partly to convert attributes from a [Test Kitchen][test-kitchen] YAML file to a nice JSON object that can be consumed by [Vagrant][vagrant]'s [Chef provisioner][vagrant-chef].
......
......@@ -5,7 +5,7 @@ description: Why I'm starting to use blog posts as a form of documentation, and
categories: musings thoughts
tags: musings blogumentation thoughts
---
You may have noticed that recently I've been writing more articles, often tagged under [`findings`][findings]. These short articles are concerned with documenting a piece of information about certain workflow-enhancing tips, and I find they fit under a term I have coined `blogumentation`, that is, blog posts as a form of documentation.
You may have noticed that recently I've been writing more articles, often tagged under [`blogumentation`][blogumentation]. These short articles are concerned with documenting a piece of information about certain workflow-enhancing tips, and I find they fit under a term I have coined `blogumentation`, that is, blog posts as a form of documentation.
I believe that blog posts can be better suited for documentation than a wiki for cases where it helps to have more of a narrative as to _why_ you'd want to do something, rather than just the "this is how you do it". Of course you have to be careful not to make it a large wall of text, ensuring that it is also possible to skim-read and extract out the required tidbits to complete the task.
......@@ -48,7 +48,7 @@ If you wish to hear me write about something, please [raise an issue on my issue
[issue-board-article]: https://gitlab.com/jamietanna/jvt.me/boards/320660
[keysleft]: http://keysleft.com
[extracting-certs]: {% post_url 2017-04-28-extract-tls-certificate %}
[findings]: /categories/findings/
[blogumentation]: /categories/blogumentation/
[docker-systemd-article-issue]: https://gitlab.com/jamietanna/jvt.me/issues/151
[technotts-twitter]: https://twitter.com/TechNottingham
[technotts-blog-channel]: https://technottingham.slack.com/messages/C4WR48CTB/
......
......@@ -2,8 +2,8 @@
layout: post
title: 'Testing `include_recipe`s with Chef and ChefSpec'
description: How to best test `include_recipe`s within your Chef recipes, as well as how to ensure that you aren't running any dependent recipes in your tests.
categories: findings
tags: findings chef tdd chefspec
categories: blogumentation
tags: blogumentation chef tdd chefspec
image: /assets/img/vendor/chef-logo.png
---
While writing cookbooks, both personally and professionally, I practice a heavy use of TDD to ensure that the recipes are doing what I expect them to. As part of this, I will want to test both standard resources, as well as `include_recipe`s:
......
......@@ -2,8 +2,8 @@
layout: post
title: 'Getting around `Permission Denied` when running ChefSpec'
description: How to handle getting an `EACCES` when trying to run ChefSpec on a recipe.
categories: findings
tags: findings chef chefspec chefdk
categories: blogumentation
tags: blogumentation chef chefspec chefdk
no_toc: true
image: /assets/img/vendor/chef-logo.png
---
......
......@@ -2,7 +2,7 @@
layout: post
title: Trusting Self-Signed Certificates from the Chef Development Kit
description: How to get the ChefDK (and associated tools) to trust internal / self-signed certificates, in an easy oneliner.
categories: findings chef
categories: blogumentation chef
tags: chef chefdk certificates berkshelf
no_toc: true
image: /assets/img/vendor/chef-logo.png
......
......@@ -2,8 +2,8 @@
layout: post
title: 'Running `service` resources in Kitchen-Docker'
description: How to get up and running with `service` resources when running Test Kitchen with the Docker driver, in this example for use with GitLab CI.
categories: findings chef kitchen docker
tags: findings chef kitchen docker howto
categories: blogumentation chef kitchen docker
tags: blogumentation chef kitchen docker howto
image: /assets/img/vendor/chef-logo.png
---
......
......@@ -507,7 +507,7 @@ If you've made it this far I want to say thanks for reading! And even if you had
[gitlab-first-prod-deploy]: https://gitlab.com/jamietanna/jvt.me/commit/545d721056d33e5b3144fbfa513ae787c61b2b0c
[jvtme-talks]: /talks/
[category-fosdem]: /categories/fosdem/
[tag-findings]: /tags/findings/
[tag-findings]: /tags/blogumentation/
[matomo]: https://matomo.org
[piwik-rename-matomo]: https://matomo.org/blog/2018/01/piwik-is-now-matomo/
[jekyll-seo-tag]: https://github.com/jekyll/jekyll-seo-tag
......
......@@ -2,8 +2,8 @@
layout: post
title: '`SSLError` When Running Berkshelf Behind a Proxy'
description: 'Getting around the pesky `OpenSSL::SSL::SSLError SSLv2/v3 read server hello A` error when running Berkshelf behind a proxy'
categories: findings
tags: chef findings proxy cli shell chefdk berkshelf
categories: blogumentation
tags: chef blogumentation proxy cli shell chefdk berkshelf
no_toc: true
image: /assets/img/vendor/chef-logo.png
---
......
......@@ -2,8 +2,8 @@
layout: post
title: Emoji Support in Dunst
description: How to see Emoji when using the Dunst notification system.
categories: findings
tags: archlinux dunst dotfiles findings emoji
categories: blogumentation
tags: archlinux dunst dotfiles blogumentation emoji
no_toc: true
---
## TL;DR
......
---
title: 'Chef 13 Upgrade: Rubocop Changes for `lazy` Parameters'
description: 'How to resolve the `Parenthesize the param lazy` Rubocop error when upgrading your cookbook to Chef 13.'
categories: findings chef-13-upgrade
tags: findings chef-13-upgrade chef-13-upgrade-rubocop chef rubocop chef-13 rubocop-0-49
categories: blogumentation chef-13-upgrade
tags: blogumentation chef-13-upgrade chef-13-upgrade-rubocop chef rubocop chef-13 rubocop-0-49
no_toc: true
image: /assets/img/vendor/chef-logo.png
---
......
---
title: 'Chef 13 Upgrade: Rubocop Changes for Testing `render_file` with ChefSpec and a `with_content` Block'
description: 'How to resolve the `Parenthesize the param render_file` Rubocop error when upgrading your cookbook to Chef 13.'
categories: findings chef-13-upgrade
tags: findings chef-13-upgrade chef-13-upgrade-chefspec chef chefspec
categories: blogumentation chef-13-upgrade
tags: blogumentation chef-13-upgrade chef-13-upgrade-chefspec chef chefspec
no_toc: true
image: /assets/img/vendor/chef-logo.png
---
......
---
title: 'Chef 13 Upgrade: Testing `ruby_block`s with ChefSpec'
description: 'Replace your `block.old_run_action` with `block.block.call` to trigger `ruby_block`s within ChefSpec 7 and Chef 13.'
categories: findings chef-13-upgrade
tags: findings chef-13-upgrade chef-13-upgrade-chefspec chef chefspec chef-13 chefspec-7
categories: blogumentation chef-13-upgrade
tags: blogumentation chef-13-upgrade chef-13-upgrade-chefspec chef chefspec chef-13 chefspec-7
no_toc: true
image: /assets/img/vendor/chef-logo.png
---
......
---
title: 'Chef 13 Upgrade: Lessons Learnt and Documented for Posterity'
description: 'Notes on the main problems encountered when upgrading from Chef 12 to Chef 13, both with ChefSpec and Rubocop.'
categories: findings chef-13-upgrade
tags: findings chef-13-upgrade chef-13-upgrade-rubocop chef-13-upgrade-chefspec chef rubocop chefspec chef-13 chefspec-7 rubocop-0-49
categories: blogumentation chef-13-upgrade
tags: blogumentation chef-13-upgrade chef-13-upgrade-rubocop chef-13-upgrade-chefspec chef rubocop chefspec chef-13 chefspec-7 rubocop-0-49
no_toc: true
image: /assets/img/vendor/chef-logo.png
---
......
---
title: 'Chef 13 Upgrade: Rubocop Changes for Word Array Literals (`%w`)'
description: 'A one-liner shell command to fix Rubocop errors `%w-literals should be delimited by [ and ].`'
categories: findings chef-13-upgrade
tags: findings chef-13-upgrade chef-13-upgrade-rubocop chef rubocop chef-13 rubocop-0-49
categories: blogumentation chef-13-upgrade
tags: blogumentation chef-13-upgrade chef-13-upgrade-rubocop chef rubocop chef-13 rubocop-0-49
no_toc: true
image: /assets/img/vendor/chef-logo.png
---
......
---
title: 'Chef 13 Upgrade: Deprecation of Namespace Collisions in Custom Resources'
description: 'Preparing for breaking changes in Chef 14 by renaming `property_name` to `new_resource.property_name` in Custom Resources.'
categories: findings chef-13-upgrade
tags: findings chef-13-upgrade chef-13-upgrade-deprecation chef chef-13 chef-14
categories: blogumentation chef-13-upgrade
tags: blogumentation chef-13-upgrade chef-13-upgrade-deprecation chef chef-13 chef-14
no_toc: true
image: /assets/img/vendor/chef-logo.png
---
......
---
title: 'Chef 13 Upgrade: `knife-cookbook-doc` gem upgrade'
description: 'Fixing odd `Logger` entries in autogenerated `knife-cookbook-doc` `README.md`s for Chef 13'
categories: findings chef-13-upgrade
tags: findings chef-13-upgrade chef knife-cookbook-doc chef-13 documentation
categories: blogumentation chef-13-upgrade
tags: blogumentation chef-13-upgrade chef knife-cookbook-doc chef-13 documentation
no_toc: true
image: /assets/img/vendor/chef-logo.png
---
......
---
title: Verify a Ruby Class Method is Called with Arguments in Rspec, Without Doubles or Mocks
description: Rspec code to verify that a Ruby Class Method is called from another method, without needing to mock anything.
categories: findings ruby
tags: findings ruby testing rspec
categories: blogumentation ruby
tags: blogumentation ruby testing rspec
no_toc: true
---
While working on [Testing Chef's `ruby_block`s with ChefSpec][testing-ruby_block-chefspec], I found that I was struggling to find any resources explaining my seemingly niche request:
......
---
title: "Testing Chef's `ruby_block`s with ChefSpec"
description: 'Testing implementation of a `ruby_block` in ChefSpec, to ensure that the code executes as expected'
categories: findings chef
tags: findings chef chefspec testing
categories: blogumentation chef
tags: blogumentation chef chefspec testing
image: /assets/img/vendor/chef-logo.png
---
I like to ensure that all my code is as well unit tested as possible, both so I can quickly iterate changes, and to ensure that future changes don't inadvertently break functionality.
......
---
title: 'Chef 13 Upgrade: `knife-cookbook-doc` Rubocop Updates'
description: 'Disabling the `Missing space after #` and `Do not use block comments` errors for your `knife-cookbook-doc` formatted comments.'
categories: findings chef-13-upgrade
tags: findings chef-13-upgrade chef knife-cookbook-doc chef-13 documentation chef-13-upgrade-rubocop
categories: blogumentation chef-13-upgrade
tags: blogumentation chef-13-upgrade chef knife-cookbook-doc chef-13 documentation chef-13-upgrade-rubocop
no_toc: true
image: /assets/img/vendor/chef-logo.png
---
......
......@@ -2,8 +2,8 @@
layout: post
title: 'Running `docker login` as another user in Chef'
description: 'Hitting the error `permission denied while trying to connect to the Docker daemon socket` when trying to run `docker login` as a non-root user in Chef.'
categories: findings
tags: docker chef findings
categories: blogumentation
tags: docker chef blogumentation
no_toc: true
image: /assets/img/vendor/chef-logo.png
---
......
---
title: Executing an Interactive Python Shell (REPL) for a Script
description: 'Using `python -i` to get an interactive REPL after running a Python source file.'
categories: findings
tags: cli python findings tools howto
categories: blogumentation
tags: cli python blogumentation tools howto
image: /assets/img/vendor/python-logo-notext.png
no_toc: true
---
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment