Giter Club home page Giter Club logo

docs-next-zh-cn's Issues

协作指引

欢迎参与 Vue 3 中文文档仓库协作,在开始之前建议您阅读以下内容,非常感谢您的参与:

协作步骤

  1. 阅读以下内容:

  2. “翻译进度” 认领章节发起新的 issue:

    标题格式为(精确至文件定位),如:

    • 认领未翻译:【翻译】:src/community/team.md
    • 认领校对:【校对】:src/README.md

    当你完成翻译或校对后,发起 PR,在 PR 的讨论中,附上 issue 地址,让我们知道你此 PR 的关联 issue ,并随时在上述 issue 中报告你的翻译进度。

常见问题

  1. 发现有些段落翻译晦涩难懂?

    • 在搜索未得到相关讨论结果后,可发起 issue ,有结论后,我们定期汇总至 术语翻译约定 wiki
  2. 如何发起 Pull Requests

    • clone 仓库
      image
    • 更改完毕后,推送到自己的仓库
    • 比较仓库,右侧为你的仓库和分支,左侧是需要并入的目标仓库和分支
      image
    • 选择比较的分支后,点击按钮:“Create pull request” 即可发起
  3. 如何查看“我的贡献”?

  4. 新发现一个新的特性,但没有被 “翻译进度” 收录?

  5. 发起 PR 的标题?

    • 我们建议你使用英文作为标题,并简明扼要的概括,在该 PR 的评论中追加特性说明
  6. 如果想在赞助本仓库?

    • todo
  7. 如果有一个章节很长,我只翻译了一半,后续不想翻译了?

    • 虽然允许,但,我们还是建议你,最好以一个 .md 文件为单位来发起 PR,避免后续来回追踪。
  8. 对于有原英文有自己的见解?

  9. 对于网站架构上有自己的见解?

  10. 对于 Vue 技术的讨论?

    • 对于 Vue 的使用答疑,请移步到各大技术社区讨论

部分 property 推荐进行翻译

image
比如该图片里的内容,ref对象只包含一个名为value的property,这个地方,翻译为 ref对象只包含一个名为value的属性 会不会更加贴切一点

关于 “reactive” 和 “reactivity ” 翻译讨论

来自 #52@Justineo 的建议:

reactive 译为“响应式”的话,reactivity 是不是翻译为“响应性”更好?

我摘了英文版实际例子来对比下。

例子 代入翻译
reactive proxy 响应式prop
reactive state 响应式状态
reactive property 响应式 property
reactivity tracking 响应性追踪
losing reactivity 丢失响应性
reactivity system 响应性系统

这个术语翻译,据我所知,改动可能比较广泛,现独立 issue ,做为专门的讨论。

@Justineo @Jinjiang

v3文档翻译有误

传入

image

原文: Let's take a look at modal-button.
翻译:为此,我们可以使用 Vue 的内置 组件:

文档翻译有误

在src/api/global-api中关于resolveComponentresolveDirective的返回值的翻译应该是有问题的。

20200921203703
20200921203741

个人觉得应该是:
返回一个 Component 或没有找到时返回 undefined

返回一个 Directive 或没有找到时返回 undefined

v3文档翻译有误

链接地址
如上链接,中的MyBook.vue示例代码中注释。
// Attribute (响应式 object)// Slots (响应式 object) 应该译为非响应式object

集中翻译和校对工作汇总

大家好,目前 Vue 3.0 的中文文档站处在刚刚起步的状态,有大量的文档有待集中翻译和校对,也希望可以得到社区的大力支持!

所以我们创建了这个 issue 来汇总这些工作。

首先介绍一下目前文档站的状态:

  1. 我们按照页面为颗粒度将所有需要翻译和校对的页面统计在了 GitHub project board:https://github.com/vuejs/docs-next-zh-cn/projects/3
  2. 每个页面理论上都需要经历“未翻译”、“正在翻译”、“已翻译未校对”、“已完成”四个状态。

如何参与本次集中翻译和校对

目前的页面有两类状态,一类是英文版,尚未翻译,另一类是已经翻译但是并未有其他人校对。

  • 对于尚未翻译的内容

    1. 创建一则新的 issue 认领翻译,我们看到之后会整理到 project board (移动到"正在翻译",并注明认领人)
    2. 翻译完毕后,提交并创建 PR,我们看到之后整理到 project board (移动到"已翻译待校对")
    3. 超过社区 2 人或有 Vue 团队成员校对并 approve 之后,我们合并分支并整理到 project board (移动到"已完成")
    4. 该 issue 关闭
  • 对于已经翻译但尚未校对的内容

    1. 创建一则新的 issue 认领校对,我们看到之后会整理到 project board (移动到“已翻译待校对”,并注明认领人)
    2. 校对完毕后,提交修改意见并创建 PR
    3. Vue 团队成员进行校对和合并分支,并整理到 project board (移动到已完成)
    4. 该 issue 关闭

注意可以重复校对,但我们会尽量回避大家重复翻译和过度集中校对某一篇文档,所以建议大家参与之前来这里认领一下以避免其他人重复翻译或过度校对。

翻译相关的注意事项

详见 wiki

如果大家有兴趣参与翻译和校对,欢迎创建 issue 认领相关工作!

谢谢

中文仓库是否支持algolia特性?

有一个原仓库的特性:使用了 algolia,但仅支持英文现在。

我尝试注册了 algolia,发现需要还需要特别做搜索的 json 文件。

如果是这样,官方库做 i18n 就很麻烦,需要各个 i18n 库都需要制作自己的 json 文件来支持搜索。

————————————————————————————————
2020年9月20日:
由于中文库移除了 algolia 特性,再加上原英文仓库 变量有问题,这导致了中文仓库丢失了搜索功能,已给英文 PR 修复该问题。

本地搜索框恢复后,将会给 algolia 提交 PR,以增加 algolia 特性。

原仓库使用 Github Actions 对 PR 打标签

这是否需要呢?这似乎需要调用一个 bot,@github-actions 。

@Jinjiang ,我需要移除原先的 pr.yaml 才可以继续(暂时已移除),后续需要组织授权才可以使用调用这个脚本。

否则一直报错:Only actions in "vuejs" are allowed for this repository

bug:console error report when the scrollBehavior selector is invalid

下面有两个bug:

vue-router 缺陷引发

  1. 在生产环境下,直接访问具体的页面,如:/guide/installation.html
    再次刷新,控制台报错,进而导致
    image

app.2e9ad43d.js:6 DOMException: Failed to execute 'querySelector' on 'Document': '#%E5%A4%84%E7%90%86%E7%94%A8%E6%88%B7%E8%BE%93%E5%85%A5' is not a valid selector.

相关issue:

该bug不影响功能,只是无法触发点击h标签,无法滚动

进入指南,几个深层的菜单栏无法展开

生产环境下,主页进入起步,两个无法展开迁移侧栏菜单:从Vue 2迁移、贡献文档。(影响使用)
控制台报错。

app.2e9ad43d.js:6 DOMException: Failed to execute 'appendChild' on 'Node': This node type does not support this method.

image

相关issue:

关于是否统一迁移符号到加粗符号外讨论

该讨论来自#49 ,现独立出来发起 issue 讨论

@Jinjiang

标点符号写在星号里面似乎不影响解析和渲染,这种情况下我们是否需要刻意并统一把标点符号移到外部?

仅当加粗 **...** 右侧有汉字时候,需要迁移到加粗符号 **外面,但如果加粗符号 ** 外无汉字,也是可以渲染的。

demo:

- **你好,**世界   // 失败
- **你好,** 世界  // 成功
- **你好**,世界   // 成功

@Jinjiang @Justineo

目前有三种方法可选:

  1. 加粗 ** 最后一个符号,一律移到它的右侧,如:
  • **你好,**世界 ==> **你好**,世界
    -**你好,世界。** ==> **你好,世界**
  1. 最后一个 ** 右侧如有汉字可空格,否则原样,如:
  • **你好,**世界 ==> **你好,** 世界
  • **你好,**世界 ==> **你好,**世界
  1. 如果 ** 最后一个符号存在且右侧存在汉字时,符号迁移到右侧,否则可保留原版,否则,如:
  • **该钩子在服务器端渲染期间不被调用。** 世界 ==>**该钩子在服务器端渲染期间不被调用**。 世界
  • **该钩子在服务器端渲染期间不被调用。** ==>**该钩子在服务器端渲染期间不被调用。**

使用 zhlint 检查文件时出现错误

如图所示,在校验 src/api/global-api.md 时出现错误:

wHJc5D.png

我也试过校验其他几个文件(文件名有 - 的,或者只有一个单词的)都能校验成功QAQ:

wHYlJe.png

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.