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

Feature: add post metadata #21

Closed
1 task done
0-vortex opened this issue Oct 30, 2021 · 10 comments
Closed
1 task done

Feature: add post metadata #21

0-vortex opened this issue Oct 30, 2021 · 10 comments
Labels
accepting prs Please work on this 🍕 enhancement 💡 feature A label to note if work is a feature help wanted

Comments

@0-vortex
Copy link
Contributor

Type of feature

Feature

Current behavior

Anyone adding a new post or article is not officially credited outside of GitHub contributions

Desired solution

Use metadata to add author information and other social links

Additional context

No response

Code of Conduct

  • I agree to follow this project's Code of Conduct
@0-vortex 0-vortex added 💡 feature A label to note if work is a feature 👀 needs triage accepting prs Please work on this help wanted 🍕 enhancement and removed 👀 needs triage labels Oct 30, 2021
@nightknighto
Copy link
Contributor

Where exactly are these posts or articles? The docs website only displays documentation pages.

@0-vortex
Copy link
Contributor Author

Where exactly are these posts or articles? The docs website only displays documentation pages.

Are you familiar with https://docusaurus.io/docs/markdown-features#front-matter ? We are using docusaurus to create the docs 🍕

@nightknighto
Copy link
Contributor

Yes I had a look on it. So you want the meta data on the "docs" pages right? What I initially understood is that there is a separate blog for posts or something.

@0-vortex
Copy link
Contributor Author

Yes I had a look on it. So you want the meta data on the "docs" pages right? What I initially understood is that there is a separate blog for posts or something.

No, the issue was about making the "author" clickable as we only really have GitHub username authors - https://docusaurus.io/docs/blog#blog-post-authors sheds more light on the 2 ways to do it!

@nightknighto
Copy link
Contributor

No, the issue was about making the "author" clickable as we only really have GitHub username authors - https://docusaurus.io/docs/blog#blog-post-authors sheds more light on the 2 ways to do it!

Is this the author section you're talking about?
image
Because I can't find any other section for authors in the project https://docs.opensauced.pizza/

@huynhicode
Copy link
Contributor

huynhicode commented Sep 30, 2022

For the doc metadata, you can add something like this to the top of each md file:

---
id: head-metadata
title: Head Metadata
---

I am familiar with Docusaurus and wouldn't mind taking on this issue @0-vortex @Deadreyo

Or maybe create a new issue for adding metadata? I think this issue is for blog authors specifically?

@nightknighto
Copy link
Contributor

For the doc metadata, you can add something like this to the top of each md file:

---
id: head-metadata
title: Head Metadata
---

I am familiar with Docusaurus and wouldn't mind taking on this issue @0-vortex @Deadreyo

Or maybe create a new issue for adding metadata? I think this issue is for blog authors specifically?

Yes this is a different issue. Here we're discussing modifying the "last updated" section to include a link to the author's profile.
Maybe this issue can be renamed to be more precise.

@nightknighto
Copy link
Contributor

Ok so I researched about it, and there doesn't seem to be a configurable supported way by the framework to get any more details about the author.

I've also asked on their github discussions, and got this message, which clarifies that they dont handle email adressess / profile links due to the mentioned reasons.

image

The suggested answer by the collaborator was to make an email / link field that would be manually filled by the author upon updating the page.


Issues with this solution:

  • last_update frontmatter is not supported in this version of docusaurus. Will have to update.
  • The updater/author may forget to edit the link field, leading to names having wrong links.
  • Of course the need to update a field, instead of currently just applying the content edits.
  • Will require modification of the plugin-content-docs library

@huynhicode
Copy link
Contributor

For the doc metadata, you can add something like this to the top of each md file:

---
id: head-metadata
title: Head Metadata
---

I am familiar with Docusaurus and wouldn't mind taking on this issue @0-vortex @Deadreyo
Or maybe create a new issue for adding metadata? I think this issue is for blog authors specifically?

Yes this is a different issue. Here we're discussing modifying the "last updated" section to include a link to the author's profile. Maybe this issue can be renamed to be more precise.

I have created an issue: #45 and will work on adding and configuring the head metadata.

@CBID2
Copy link
Contributor

CBID2 commented Aug 18, 2023

Hey @0-vortex. Any update on this?

@BekahHW BekahHW closed this as completed Sep 12, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
accepting prs Please work on this 🍕 enhancement 💡 feature A label to note if work is a feature help wanted
Projects
None yet
Development

No branches or pull requests

5 participants