-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
vaunt: update achievement images and add vaunt documentation (#16466)
- Loading branch information
Showing
3 changed files
with
72 additions
and
0 deletions.
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,72 @@ | ||
# 如何在你的 GitHub 个人资料页上添加 TiDB 文档挑战赛徽章 | ||
|
||
[GitHub 个人资料页](https://docs.github.com/zh/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/about-your-profile)不仅仅是你的 GitHub 仓库的集合,更是你在编程领域中的专业身份标志。 | ||
|
||
本指南介绍如何在你的 GitHub 个人资料页上添加 [2024 TiDB 文档挑战赛](https://asktug.com/t/topic/1019364) (TiDB Docs Dash) 活动徽章。 | ||
|
||
## 第 1 步:创建一个仓库,存放个人资料 README | ||
|
||
如果你已经配置了 GitHub 个人资料 README,请跳过以下步骤,直接进入[第 2 步:编辑个人资料 README](#第-2-步编辑个人资料页-readme)。 | ||
|
||
1. 在 GitHub 任一页面的右上角,点击 **+**,然后点击 **New repository**。 | ||
|
||
<img src="https://docs.github.com/assets/cb-34248/mw-1440/images/help/repository/repo-create-global-nav-update.webp" width="350" /> | ||
|
||
2. 以你的 GitHub 用户名命名该仓库。例如,如果你的用户名为 `ilovetidb`,则仓库名必须为 `ilovetidb`。 | ||
3. 选择 **Public** 将该仓库设置为公共可见。 | ||
4. 在 **Initialize this repository with:** 下面,选择 **Add a README file**。 | ||
5. 点击 **Create repository**。 | ||
|
||
## 第 2 步:编辑个人资料 README | ||
|
||
1. 在你的 `<github_username>` 仓库的 GitHub 页面上,点击右侧边栏上方的 **Edit README**。 | ||
2. 在 README 文件中添加以下代码,并将 `{{github_username}}` 替换为你的 GitHub 用户名,然后提交更改。 | ||
|
||
```HTML | ||
<p> | ||
<img src="https://api.vaunt.dev/v1/github/entities/{{github_username}}/achievements?format=svg&limit=3" width="350" /> | ||
</p> | ||
``` | ||
|
||
此时,刷新你的 GitHub 个人资料页,即可看到 TiDB Docs Dash 活动徽章。 | ||
|
||
关于如何管理个人资料 README 的更多信息,请参阅 [GitHub 文档](https://docs.github.com/zh/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/managing-your-profile-readme)。 | ||
|
||
## (可选)通过 Vaunt 添加更多展示 | ||
|
||
本次 TiDB 文档挑战赛的徽章是通过 [Vaunt](https://vaunt.dev/) 授予的,Vaunt 是一个开发者关系平台,旨在赋能和发展开发者社区。 | ||
|
||
通过 Vaunt 提供的以下功能,你还可以在你的个人资料 README 中展示你在其它开源项目中做出的贡献: | ||
|
||
- 集成你的 developer card 到个人资料 README | ||
|
||
示例卡片: | ||
|
||
<p> | ||
<a href="https://vaunt.dev"> | ||
<img src="https://api.vaunt.dev/v1/github/entities/jeff1010322/contributions?format=svg" width="350" /> | ||
</a> | ||
</p> | ||
|
||
如需集成你的 developer card,请将以下代码添加到你的 README 文件中,并将 `{{github_username}}` 替换为你的用户名。 | ||
|
||
```HTML | ||
<p> | ||
<a href="https://vaunt.dev"> | ||
<img src="https://api.vaunt.dev/v1/github/entities/{{github_username}}/contributions?format=svg" width="350" /> | ||
</a> | ||
</p> | ||
``` | ||
|
||
- 集成你的社区贡献看板到个人资料 README | ||
|
||
社区贡献看板通过视图的形式,可以综合展示你在 GitHub 各个仓库的贡献统计数据。 | ||
|
||
[![VauntCommunity](https://api.vaunt.dev/v1/github/entities/pingcap/badges/community)](https://community.vaunt.dev/board/pingcap) | ||
|
||
- 查看[你的社区看板](https://community.vaunt.dev/)。 | ||
- 如需集成你的社区看板,请将以下代码添加到你的 README 文件中,并将 `{{github_username}}` 替换为你的 GitHub 用户名: | ||
|
||
```Markdown | ||
[![VauntCommunity](https://api.vaunt.dev/v1/github/entities/{{github_username}}/badges/community)](https://community.vaunt.dev/board/{{github_username}}) | ||
``` |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.