Skip to content
This repository was archived by the owner on Dec 4, 2017. It is now read-only.

建议在doc头部添加matadata信息 #155

Open
rootsongjc opened this issue Sep 17, 2017 · 5 comments
Open

建议在doc头部添加matadata信息 #155

rootsongjc opened this issue Sep 17, 2017 · 5 comments

Comments

@rootsongjc
Copy link

rootsongjc commented Sep 17, 2017

鉴于以下几点原因,建议在文档头部追加译者的GitHub账号,如同英文版中的那样。

  1. 一篇doc每个月更新后,最初的译者也不一定会跟着更新翻译,所以每篇doc的译者可以是多个人,同样的reviewer也可以是多个人
    译者的GitHub账号应该在doc中注明,写在文章的metadata中,例如下面这一篇文章最顶部的mata信息:
---
title: Extending the Kubernetes API with the aggregation layer
assignees:
- lavalamp
- cheftako
- chenopis
---
  1. 中文版应该在其中加入中文译者(是否要包含reviewer的信息?)的GitHub账号信息,例如:
---
title: Extending the Kubernetes API with the aggregation layer
cn-title: 通过聚合层扩展 kubernetes API
assignees:
- lavalamp
- cheftako
- chenopis
cn-assignees:
- rootsongjc
- xxx
---
  1. title部分是不是也应该再单独设置一个中文标题mata信息,同时保留原来的英文title,这样在翻译的过程中就不用删除原来的英文标题,而markdown渲染为html文件时可以根据译文语言选择不同语言版本的title
@rootsongjc rootsongjc changed the title 在doc头部添加matadata信息 建议在doc头部添加matadata信息 Sep 17, 2017
@brucehex
Copy link
Member

brucehex commented Sep 17, 2017

@rootsongjc 这是一个好建议,建议也增加一个review字段..关于第三点现在操作有点难度,我目前了解的是还没办法做到按语言构建,如果可以按语言构建,当然是最好,欢迎大家提意见..

我注意到新的文档 字段 assignees 已经换成了 approvers ..

@rootsongjc
Copy link
Author

如果要做到按语言构建,必然要对CI工具的脚本做出修改,这一点需要官方协调。而在头信息中增加approvers和reviewers的GitHub账号,这一点不需要官方协调,也不影响文档构建。

@markthink
Copy link
Member

晚上更新一下README文档,增加这些说明。

@chentao1596
Copy link

reviewers是在PR提交之后才行确定的,所以,我理解,这个字段应该是往上游推送PR时才需要的吧?谢谢!

@rootsongjc
Copy link
Author

官方仓库的reviewer字段是什么时候生成的呢?难道要每个提PR的人手动写的吗?我觉得应该是自动注入吧?

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants