Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Headers content #8

Closed
ltagliaferri opened this issue Jul 14, 2022 · 3 comments · Fixed by #30
Closed

Headers content #8

ltagliaferri opened this issue Jul 14, 2022 · 3 comments · Fixed by #30
Labels
enhancement New feature or request question Further information is requested

Comments

@ltagliaferri
Copy link
Collaborator

For discussion — I wanted to know what we think about the current headers @jamonation @erikaheidi

For example, on the tutorial about how to sign an SBOM, they look like this in markdown:

---
title: "How to Sign an SBOM with Cosign"
type: "article"
description: "Signing software bills of materials with Cosign"
lead: "Use Cosign to sign a software bill of materials"
date: 2022-13-07T15:22:20+01:00
lastmod: 2022-13-07T15:22:20+01:00
draft: false
images: []
menu:
  docs:
    parent: "sigstore"
weight: 620
toc: true
---

On the site it looks like this:

Screen Shot 2022-07-13 at 10 35 39 PM

We don't have the lead or description coming into the blog post cards:

Screen Shot 2022-07-13 at 10 37 00 PM

But the description I believe will be indexed by search engines.

We also don't have the date coming into the front end.

In terms of authors, we don't have authors either in the headers or on the frontend. And we may want to have that as well as author landing pages. But authorship may be less important for straight documentation.

What are your thoughts?

@ltagliaferri ltagliaferri added enhancement New feature or request help wanted Extra attention is needed question Further information is requested and removed help wanted Extra attention is needed labels Jul 14, 2022
@erikaheidi
Copy link
Collaborator

I agree that the article page and the list page definitely can use a bit more metadata. Author info can be a bit more challenging because we'd need to pull the data from somewhere (or, just use a generic front mater field for author string and display that?).

I think it's gonna be easy to add the other info that's already on the front mater thou. Let me look into that.

@ltagliaferri
Copy link
Collaborator Author

We could start with a generic author string and no author landing page. I think it would be nice long term to collect authors' posts together, there is precedent with the Chainguard blog doing this.

This was how Katy added authors on Sourcegraph Learn in case this is worth reviewing later on: https://github.com/sourcegraph/learn/pull/321/files

@ltagliaferri
Copy link
Collaborator Author

I added contributors based on how it looks in the blog in #24

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request question Further information is requested
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants