Skip to content

Commit 2efeff5

Browse files
committed
docs: improve add author instructions
1 parent 0a24323 commit 2efeff5

File tree

2 files changed

+35
-8
lines changed

2 files changed

+35
-8
lines changed

archetypes/blog.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@ date: "{{ now.Format "2006-01-02" }}"
44
# If default Espressif author is needed, uncomment this
55
# showAuthor: true
66
# Add a summary
7-
summary: "Replace it with a brief summary that capture the essence of (1) what the article is about and (2) how the reader will benefit from reading it. For examples, check other article summaries."
8-
# Create your author entry
7+
summary: "Replace it with a brief summary that captures the essence of (1) what the article is about and (2) how the reader will benefit from reading it. For examples, check other article summaries."
8+
# Create your author entry (for details, see https://developer.espressif.com/pages/contribution-guide/writing-content/#add-youself-as-an-author)
99
# - Create your page at `content/authors/<author-name>/_index.md`
1010
# - Add your personal data at `data/authors/<author-name>.json`
11-
# - Add your author name(s) below
11+
# - Add author name(s) below
1212
authors:
1313
- "author-name" # same as in the file paths above
1414
# Add tags

content/pages/contribution-guide/writing-content/index.md

Lines changed: 32 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -68,13 +68,40 @@ To add yourself as an author, [create an article](#create-and-view-an-article) a
6868

6969
If the article already exists and you want to edit the authors, here are the same instructions:
7070

71-
- Create your author entry
72-
- Create your page at `content/authors/<author-name>/_index.md`
73-
- Add your personal data at `data/authors/<author-name>.json`
74-
- Add the following to your article's YAML header
71+
- Create your author entry<br>
72+
{{< alert >}}
73+
Replace all `author-name` and `Author Name` instances below with your own name, for example `john-doe` and `John Doe` respectively
74+
{{< /alert >}}
75+
- Create your page at `content/authors/author-name/_index.md`
76+
```markdown
77+
---
78+
title: Author Name
79+
---
80+
81+
<!-- (optional) Add a few words about yourself -->
82+
```
83+
- (optional) Add your image in [WebP format](#use-webp-for-raster-images) at the path
84+
```sh
85+
assets/img/authors/author-name.webp
86+
```
87+
- Add your personal data at `data/authors/author-name.json`<br>
88+
(In `image`, add your image or use the default one: `img/authors/espressif.png`)
89+
```json
90+
{
91+
"name": "Author Name",
92+
"image" : "img/authors/author-name.webp",
93+
"bio": "(optional) Your role at Espressif",
94+
"social": [
95+
{ "linkedin": "https://www.linkedin.com/..." },
96+
{ "github": "https://github.com/..." }
97+
]
98+
}
99+
```
100+
- Add author name(s) to your article's YAML header
75101
```yaml
76102
authors:
77-
- "<author-name>" # List your name(s)
103+
- "author-name" # same as in the file paths above
104+
- "another-author"
78105
```
79106
80107
In some cases, it might be better to add the default Espressif author:

0 commit comments

Comments
 (0)