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

Instructions for creating authors are not complete #109

Open
georgik opened this issue Sep 5, 2024 · 1 comment
Open

Instructions for creating authors are not complete #109

georgik opened this issue Sep 5, 2024 · 1 comment
Assignees
Labels
Priority: Low Minor improvement, automation, or typos in content Status: Opened Issue is new Type: Bug Bug in developer-portal

Comments

@georgik
Copy link
Collaborator

georgik commented Sep 5, 2024

The documnet https://developer.espressif.com/pages/contribution-guide/content-writing-workflow/#add-youself-as-an-author is not accurate. It does not explain expected content of index.md.

The minimal version should be:

---
title: Juraj Michálek
---

The problem is that if you put there just name: instead of title, then the user name won't be visible at Authors page.

@f-hollow f-hollow added bug 🐞 Inconsistencies or issues which will cause a problem for users or implementers. Type: Bug Bug in developer-portal Status: Opened Issue is new Priority: Low Minor improvement, automation, or typos in content and removed bug 🐞 Inconsistencies or issues which will cause a problem for users or implementers. labels Feb 11, 2025
@FBEZ
Copy link
Collaborator

FBEZ commented Feb 28, 2025

I agree with Juraj, I had to create the first content a few weeks back and even if it's possible to look around files and folder and figure out how to do, it can be easier.

I would change these lines in the article to make it a little more verbose.

Below an example. If you like, I could create a PR.


In other cases, add yourself as an author.
You need to

  1. Create your author entry
  2. Add your personal data
  3. (optional) Add your picture.
  4. Reference yourself as an author in the article

Create your author entry

You need to create your personal page at content/authors/<author-name>/_index.md
hugo create content/authors/<author-name>/_index.md

Open the file and enter the

---
title: "John Doe"
---

Add author data

The data is stored as json at data/authors/<author-name>.json. Create the file and add

{
    "name": "John Doe",
    "image": "img/authors/john-doe.webp",
    "bio": "Espressif enthusiast",
    "social": [
        { "linkedin": "https://www.linkedin.com/in/..." },
        { "twitter": "https://x.com/..." }
    ]
}

Add your picture

If you like to add your picture (shown at the beginning of the article) you can add a webp portrait at assets/img/authors/john-doe.webp

Reference yourself as an author

In your article's YAML front-matter, add the following lines

showAuthor: false         # Hide default Espressif author
authors:
  - "<author-name>"        # List your name(s)

(BTW The link is now changed to https://developer.espressif.com/pages/contribution-guide/writing-content/#add-youself-as-an-author. )

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Priority: Low Minor improvement, automation, or typos in content Status: Opened Issue is new Type: Bug Bug in developer-portal
Projects
None yet
Development

No branches or pull requests

3 participants