search

knative / website

Hugo templates for the Knative website.
https://knative.dev
Other
23 stars 70 forks source link

Add byline to the blog #177

Closed macruzbar closed 4 years ago

macruzbar commented 4 years ago

What is changing? (Please include as many details as possible.)

We are adding a static information field to blog entries on Knative.dev

How will this impact our users?

Users will be able to know who is writing stories and can contact them if they need; Knative contributors can get more recognition for their work

In what release will this take happen (to the best of your knowledge)?

N/A ASAP

Context

Link to associated PRs or issues from other repos here.

  1. Discussion at the last Knative documentation working group

@evankanderson @carieshmarie @isdal

macruzbar commented 4 years ago

/assign @evankanderson

evankanderson commented 4 years ago

/kind good-first-issue

This probably involves updating this template: https://github.com/knative/website/blob/master/layouts/blog/baseof.html

macruzbar commented 4 years ago

@evankanderson how can we move this issue forward?

bryeung commented 4 years ago

/assign I'm going to try taking a look at this on Monday, though I'll have to start by figuring out how our website works at all.

bryeung commented 4 years ago

/assign

(Sorry, still learning the github interface.)

bryeung commented 4 years ago

I'm not sure I understand the issue. If authors put an author line in the header of the blog entry, then it will already be rendered by the template.

See the attached fake blog entry and screenshot of how it renders.

Screen Shot 2020-06-29 at 10 46 10 AM

author.html.txt

macruzbar commented 4 years ago

It looks like we only need to request that blogpost submitters add the author field on the template when they submit an .md file

---
title: "Author Example"
linkTitle: "Author Example"
author: "Jane Doe <jane@doe.org>"
date: 2020-06-29
description: "Demonstrating the author field."
type: "blog"
---

Closing this issue for now.

macruzbar commented 4 years ago

Hi @bryeung I tried adding the author field to the blog template, but it didn't work. I think we need to modify the template for it to work, but I'm not sure where to add this

bryeung commented 4 years ago

When I tried to build the website with your change included, it failed. Do we not test this before merging?

Anyway, I think you just need to quote the author and it'll work: https://github.com/knative/docs/pull/2629

There should be no change needed to the template.

macruzbar commented 4 years ago

When I tried to build the website with your change included, it failed. Do we not test this before merging?

Anyway, I think you just need to quote the author and it'll work: knative/docs#2629

There should be no change needed to the template.

Thank you!