search

sre-france / reliability.re

Reliability Report - A collaborative curated content site about Reliability Engineering
https://reliability.re
Other
9 stars 1 forks source link

Hashtags are being ignored on json files #42

Closed pabluk closed 4 years ago

pabluk commented 4 years ago

On the last PR with hashtags I saw that the hashtags field was null on the generated json file:

{
  "content": "<p>If you want to know why 100% reliability is the wrong target go to <a href=\"https://landing.google.com/sre/workbook/chapters/implementing-slos/#reliability-targets-and-error-budgets\">Chapter 2 of the SRE Workbook</a>, you&rsquo;ll find “… as you go from 99% to 99.9% to 99.99% reliability, each extra nine comes at an increased cost, but the marginal utility to your customers steadily approaches zero” between other good reasons</p>\n",
  "date": "2020-10-27T22:33:56Z",
  "github_username": "pabluk",
  "hashtags": null,
  "id": "https://reliability.re/links/2020-10-27-why-is-100-reliability-the-wrong-target/",
  "link": "https://landing.google.com/sre/workbook/chapters/implementing-slos/#reliability-targets-and-error-budgets",
  "plain": "If you want to know why 100% reliability is the wrong target go to Chapter 2 of the SRE Workbook, you&rsquo;ll find “… as you go from 99% to 99.9% to 99.99% reliability, each extra nine comes at an increased cost, but the marginal utility to your customers steadily approaches zero” between other good reasons\n",
  "title": "Why is 100% reliability the wrong target?",
  "twitter_username": "pabluk"
}

even if the markdown source file contains 2 hashtags https://github.com/sre-paris/reliability.re/pull/39/files

pabluk commented 4 years ago

After looking at this, I think it's related to a little detail about Markdown, the first hashtags is considered a comment and everything after it if ignored. So I think that must be enclosed between double quotes.

I was able to reproduce on the current main branch quoting the hashtags field on content/links/2020-10-27-why-is-100-reliability-the-wrong-target.md like this:

---
title: "Why is 100% reliability the wrong target?"
date: 2020-10-27T22:33:56Z
github_username: pabluk
twitter_username: pabluk
link: https://landing.google.com/sre/workbook/chapters/implementing-slos/#reliability-targets-and-error-budgets
hashtags: "#SLOs,#SRE"
---

and after run hugo --cleanDestinationDir the output seems correct:

jq "." public/links/2020-10-27-why-is-100-reliability-the-wrong-target/index.json
{
  "content": "<p>If you want to know why 100% reliability is the wrong target go to <a href=\"https://landing.google.com/sre/workbook/chapters/implementing-slos/#reliability-targets-and-error-budgets\">Chapter 2 of the SRE Workbook</a>, you&rsquo;ll find “… as you go from 99% to 99.9% to 99.99% reliability, each extra nine comes at an increased cost, but the marginal utility to your customers steadily approaches zero” between other good reasons</p>\n",
  "date": "2020-10-27T22:33:56Z",
  "github_username": "pabluk",
  "hashtags": "#SLOs,#SRE",
  "id": "https://reliability.re/links/2020-10-27-why-is-100-reliability-the-wrong-target/",
  "link": "https://landing.google.com/sre/workbook/chapters/implementing-slos/#reliability-targets-and-error-budgets",
  "plain": "If you want to know why 100% reliability is the wrong target go to Chapter 2 of the SRE Workbook, you&rsquo;ll find “… as you go from 99% to 99.9% to 99.99% reliability, each extra nine comes at an increased cost, but the marginal utility to your customers steadily approaches zero” between other good reasons\n",
  "title": "Why is 100% reliability the wrong target?",
  "twitter_username": "pabluk"
}