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

docs: update blog contribution guidelines #798

Merged
merged 8 commits into from
Dec 10, 2021
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 35 additions & 2 deletions website/docs/general/blog-contributing-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,8 @@ To add a new blog, please perform the following steps:

#### Blog's header information

##### Single author template

Our blogs start with a header sections containing fields such as `title`, `author`, `authorURL`, `authorImageURL`, `keywords`, `description`, and `tags`.

While `title` and `author` are starightforward, the other fields might be a bit confusing for first-time contributors. Explanations of each field is shown below. Please note that these fields could change over time.
Expand All @@ -67,13 +69,36 @@ description: description of this blog
tags: [tag1]
```

##### Co-author template

[Co-author](https://docusaurus.io/docs/next/blog#blog-post-authors) feature is added, since translating and editing articles is also time-consuming, we would like to give credit to translators and technical writers as well.

```markdown
title: "blog's title"
authors:
- name: "Author's Name"
url: "Author's GitHub"
image_url: "Author's Image URL"
- name: "Translator/Technical Writer's name"
url: "Translator/Technical Writer's GitHub"
image_url: "ranslator/Technical Writer's Image URL"
keywords:
- keywords 1
- keywords 2
- keywords 3
- keywords 4
- keywords 5
description: description of this blog
tags: [tag1]
```

##### title

Required field, the title of the article, the standard expression in the form of `title: "title"`.
Required field for single author template, the title of the article, the standard expression in the form of `title: "title"`.

##### author

Required field, the article's author name, the standard form of expression for `author: "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.

Expand All @@ -87,6 +112,14 @@ For business users or business cases, you can leave this item blank. Because Git

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

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`, and `authors.image_url.`

- `authors.name`: authors' names in plain text, for example: `name: "John Doe"`.
- `authors. url`: authors' GitHub pages, for example: `url: "www.google.com"`.
- `authors.image_url`: author's GitHub avatar.

##### keywords

Required field, keyword, which is used to enhance better SEO performance. Usually the first three keywords are "APISIX", "Apache APISIX", "API Gateway", and the last two are the article's own keywords.
Expand Down