grpc / grpc/grpc.io

Blog page front matter cleanup and simplification

Open
#402 0 comments 0 reactions 0 assignees View on GitHub
blog cleanup/refactoring e1-hours e2-days infrastructure p2-medium style
Dominant language
HTML
Stars
479
Forks
545
Avg merge
2d 7h
Merged PRs (30d)
5

Description

There are a few issues with the blog-page front matter attributes and processing. (These are thoughts that arose as I was working on #376.)

- [ ] On the old site, the `thumbnail` front-matter attribute was displayed on the left of the author's name. For example:

> ![image](https://user-images.githubusercontent.com/4140793/93525376-ef1b8e00-f903-11ea-9d65-c968bc0efda6.png)

We no longer use the `thumbnail` attribute, so consider simplifying the entries and dropping the attribute, or update the blog-entry `hero.html` partial to make use of it.

- [ ] There is a bit of an inconsistency in the design and processing of the `author` & `authors` attributes, as compared to the `position` attribute. For example, there is a separate `link` sub-attribute associated with the name of an author. In contrast, links for `position` attributes are embedded using inlined links (in mardown syntax). Since we're applying `markdownify` to the author's name anyways, we might as well simplify the processing and embed any author name links in the name field using markdown too.

- [ ] Is it really worth having both `author` and `authors` fields; the main cost is the complexity of the template (`hero.html`)

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.