You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@apisix.apache.org by ju...@apache.org on 2022/01/27 05:19:41 UTC
[apisix-website] branch master updated: docs: update single author template (#862)
This is an automated email from the ASF dual-hosted git repository.
juzhiyuan pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/apisix-website.git
The following commit(s) were added to refs/heads/master by this push:
new 5891d10 docs: update single author template (#862)
5891d10 is described below
commit 5891d1019adf4a769fb395aab86071a3a0ef60c4
Author: yilinzeng <36...@users.noreply.github.com>
AuthorDate: Thu Jan 27 13:19:31 2022 +0800
docs: update single author template (#862)
---
website/docs/general/blog-contributing-guide.md | 30 +++++--------------------
1 file changed, 5 insertions(+), 25 deletions(-)
diff --git a/website/docs/general/blog-contributing-guide.md b/website/docs/general/blog-contributing-guide.md
index 6f4934f..8376f66 100644
--- a/website/docs/general/blog-contributing-guide.md
+++ b/website/docs/general/blog-contributing-guide.md
@@ -50,9 +50,9 @@ To add a new blog, please perform the following steps:
##### Single author template
-Our blogs start with a header sections containing fields such as `title`, `author`, `authorURL`, `authorImageURL`, `keywords`, `description`, and `tags`.
+Our blogs start with a header sections containing fields such as `title`, `authors`, `authors.name`, `authors.title`, `authors.url`, `authors.image_url`, `description`, and `tags`.
-While `title` and `author` are starightforward, the other fields might be a bit confusing for first-time contributors. Explanation of each field is mentioned below. Please note that these fields could change over time.
+Some fields might be a bit confusing for first-time contributors. Explanation of each field is mentioned below. Please note that these fields could change over time.
```markdown
title: "blog's title"
@@ -95,26 +95,6 @@ description: description of this blog
tags: [tag1,tag2,...,tagn]
```
-##### title
-
-Required field for single author template, the title of the article, the standard expression in the form of `title: "title"`.
-
-##### author
-
-Required field for single author template, the article's author name, the standard form of expression for `author: "author"`.
-
-1. Community author: if you are willing to provide your real name, use your real name, if not, use your GitHub account name.
-
-2. Business case authors: please provide real name, such as John Doe.
-
-##### authorURL
-
-For business users or business cases, you can leave this item blank. Because GitHub is personal, and in the case of a business case, the person represents his company rather than himself, it is recommended that you leave this blank to avoid unnecessary controversy. This does not mean leave `authorURL`: blank, it means just delete the entire line that corresponds to it, including the variable name.
-
-##### authorImageURL
-
-The author's GitHub avatar, it is related with `authorURL`. For the same reason described above, this is an optional field. See below for how to get the avatar.
-
#### authors
The required field for co-author template. When a blog is co-authored by 2 people, please use `authors` instead of `author` to give credits to both authors. `authors` consists of the following fields: `authors.name`, `authors.url`, `authors.title` and `authors.image_url`.
@@ -147,13 +127,13 @@ Required field, tag, which is used to categorize the blog. Each post can have mo
We can help authors to use a better category once a pull request is submitted.
-#### How to get the authorImageURL or authors.image_url
+#### How to get the authors.image_url
1. Open Chrome or your preferred browser.
2. Enter the author's GitHub address to access the author's GitHub home page.
3. Right click on the author's avatar, and click "copy image address".
-4. Paste image address to the authorImageURL field.
-
+4. Paste image address to the authors.image_url field.
+
#### truncate and overview