knative / docs

User documentation for Knative components.
https://knative.dev/docs/
Other
4.42k stars 1.22k forks source link

New Knative Blog Posts don't have authors #4363

Closed omerbensaadon closed 2 years ago

omerbensaadon commented 2 years ago

Expected Behavior

When someone posts a blog, I expect to see an author and a link out to their socials

Actual Behavior

It's not clear who the author is for Blog Posts

Steps to Reproduce the Problem

  1. Load a blog post
  2. Try and find the author
omerbensaadon commented 2 years ago

CC: @psschwei

psschwei commented 2 years ago

Looking at the mkdocs blog, it looks like we'll have to manually add author names to each blog post... :cry:

github-actions[bot] commented 2 years ago

This issue is stale because it has been open for 90 days with no activity. It will automatically close after 30 more days of inactivity. Reopen the issue with /reopen. Mark the issue as fresh by adding the comment /remove-lifecycle stale.

psschwei commented 2 years ago

/remove-lifecycle stale

github-actions[bot] commented 2 years ago

This issue is stale because it has been open for 90 days with no activity. It will automatically close after 30 more days of inactivity. Reopen the issue with /reopen. Mark the issue as fresh by adding the comment /remove-lifecycle stale.

psschwei commented 2 years ago

/lifecycle frozen

snneji commented 2 years ago

I also noted that Knative blog posts don't have a date on them. I think dates are important so could we add them as part of this issue?

psschwei commented 2 years ago

Looks like there is a plan for mkdocs to support blog authors as part of adding better support for blogs: https://github.com/squidfunk/mkdocs-material/issues/3353

Might be worth weighing in on the issue if there's anything specific we'd like to see.

abrennan89 commented 2 years ago

Update blogs in Articles folder to include author names and date and remove Hugo front matter

snneji commented 2 years ago

Example: https://github.com/knative/docs/blob/main/blog/docs/articles/distributed-tracing.md

Before:

Screen Shot 2022-06-21 at 18 38 32

After (using the info from the frontmatter to add title, author, and date):

Screen Shot 2022-06-21 at 18 33 39
evankanderson commented 2 years ago

You can use the following command to get the (first) author and date for a given file.

git log --pretty="tformat:%an      %aD" --diff-filter=A -- $FILENAME