Giter Club home page Giter Club logo

docs-cn's People

Contributors

alexanderdavide avatar antfu avatar archergu avatar btea avatar chengpeiquan avatar chuanfengzhang avatar d3sox avatar docschina-bot avatar estruyf avatar george-gca avatar godkun avatar ivocin avatar jd-solanki avatar john98zakaria avatar kermanx avatar lirantal avatar lucky401 avatar luisfelipesdn12 avatar matttrice avatar mokkapps avatar nico-bachner avatar noook avatar qc-l avatar songhn233 avatar tangramor avatar tonai avatar tutods avatar twitwi avatar xiaodong2008 avatar yjl9903 avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

docs-cn's Issues

翻译任务认领说明

翻译任务认领说明

注意:

  1. 一次尽量只认领一篇,给其他小伙伴留些机会~

  2. 认领开始前,请务必阅读 翻译流程说明

从 Todo List 中选取未被人领取过的文章:

未被领取过:

  • install

领取过:

领取过,已完成:

领取方式,在本 issues 下评论即可。

认领任务格式:

Section | Title | 译者 | 完成时间
-- | -- | -- | --
guide |  install | @QC-L | 2021.05.18 - 2021.05.20

示例效果:

Section Title 译者 完成时间
guide install @QC-L 2021.05.18 - 2021.05.20

当完成时,请修改自己的认领评论,添加 PR 信息:

Section Title 译者 完成时间 PR
guide install @QC-L 2021.05.18 - 2021.05.20 #10

任务认领列表

Todo List:

翻译流程说明

翻译流程

本文档由 @docschina-bot 自动与英文文档同步更新,更新频次每天一次,更新时间为每周一早 6 点。因此,无需担心同步问题。

此流程遵循标准的 Github Flow,如已了解可直接略过。

Github Flow

整个翻译流程分为以下几个阶段:

  • 认领阶段
  • 翻译阶段
  • 校对阶段

认领阶段

如未认领文档就直接翻译,容易出现撞车的情况。

因此,在翻译前务必进行任务认领

认领任务,请到 Github Issues 选择想翻译的文档。翻译任务认领

选定要翻译的文档后,即可开始翻译。

翻译阶段

以 slidev 文档为例,如需对某篇文章进行翻译。

翻译过程中,请注意格式和内容的准确性。

fork 并 clone

先将 slidevjs/docs-cn 的文档仓库 fork 为个人仓库(有增删改的权限)。

将 fork 后的仓库 download 至本地,如:

git clone https://github.com/<YOUR-GITHUB-NAME>/docs-cn/

如下载过程过慢,可使用 depth 忽略以往的提交,这里不做过多赘述。

请基于 main 分支创建你的翻译分支(目的是,保证 main 分支与主仓库内容始终一致)。

例如:

git checkout -b <翻译分支> main

翻译

ps: 在开始翻译前,请务必先了解中文排版说明。

在 clone 好的文档中找到你所认领的文章,即可开始翻译。

翻译中请务必注意排版规范尽量不要让校对者在文档格式方面浪费时间

翻译完成后,请 push 至个人仓库。

git add
git commit -m 'docs(cn): 翻译的哪篇文章'
git push -u origin <翻译分支>

再创建 Pull Request 至 slidevjs/docs-cn 仓库。

注意:在创建 Pull Request 时,请尽量勾选允许其他人进行修改,便于快速修改及合并。

至此翻译阶段就结束了。

校对阶段

翻译完成请评论 @校对者

校对中,如有疑问或翻译错误,校对者会给出建议。

Github 的 PR 的评论提供了 suggestion 的功能,校对者对某行给出校对建议后,如无异议,可以直接进行合并。

而如果改动点较多,需进行本地修改时,则在本地对对应的内容进行修改,并提交到个人仓库的翻译分支即可。

注意: 无需关闭 Pull Request,Pull Reuquest 会自动追踪你的修改。

完成

校对完成后,校对者会对 PR 进行 Approve 操作,并进行 Pull Request 的合并。

当你的 Pull Request 被合并后,则代表流程结束。

其他

如需再次翻译,或同时翻译多篇。

  • 一次 pr 尽量只有一篇文章的翻译,便于回溯
  • 保证个人仓库的 main 分支始终为最新
  • 每次翻译新文章时,请基于 main 分支拉取新分支

更新个人仓库的分支

git remote add upstream https://github.com/slidevjs/docs-cn.git
git fetch upstream
git checkout main
git merge upstream/main

翻译流程

image

词汇表

这里用于讨论哪些词汇,如何翻译以及统一。

术语 译文
Section 章节
eject 弹出

本地构建文档,pnpm i 无法安装依赖

Hi,抱歉,我对pnpm不是很熟悉,我试着在本地跑一下文档,但是发现切换到site分支后,直接运行pnpm install或者pnpm i以后终端只是打印了一句:

Scope: all 10 workspace projects

然后就什么都没有发生了,依赖没有安装。我大概看了下pnpm workspace的意思,目前只能理解这是一种将各类子包放在一个仓库里,然后通过workspace进行内部依赖加载的方法。

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.