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.

Sign up for GitHub

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 tag section in blog contributing guide #861

Merged
merged 1 commit into from
Jan 26, 2022
Merged

docs: update tag section in blog contributing guide #861

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
14 changes: 8 additions & 6 deletions website/docs/general/blog-contributing-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,17 +56,19 @@ While `title` and `author` are starightforward, the other fields might be a bit

```markdown
title: "blog's title"
author: "blog's author"
authorURL: "author's GitHub ID"
authorImageURL: "author's GitHub Image"
authors:
- name: "Author's Name"
title: "Author"
url: "Author's GitHub"
image_url: "Author's Image URL"
keywords:
- keywords 1
- keywords 2
- keywords 3
- keywords 4
- keywords 5
description: description of this blog
tags: [tag1]
tags: [tag1,tag2,...,tagn]
```

##### Co-author template
Expand All @@ -90,7 +92,7 @@ keywords:
- keywords 4
- keywords 5
description: description of this blog
tags: [tag1]
tags: [tag1,tag2,...,tagn]
```

##### title
Expand Down Expand Up @@ -132,7 +134,7 @@ Required field, the description, which is used to enhance better SEO performance

##### tags

Required field, tag, which is used to categorize the blog. Each post has and can only have one tag. If more than one tag is suitable, please choose the most suitable one. The available tags and explanations are as follows. Please note that these tags and rules of applying tags could change over time.
Required field, tag, which is used to categorize the blog. Each post can have more than one tag. The available tags and explanations are as follows. If none of the tags below fits, please leave a comment in your pull request, and we will handle it together. Please note that these tags and rules of applying tags could change over time.

- **Community**: community related, e.g. "How to contribute to an open source project without writing code?"
- **Events**: event-related, for example: online live stream, event previews, meetups, and online meeting, etc.
Expand Down