Comments (8)
rst用来展现API确实会比较好, 我这里列一下优缺点:
优点
- 样式上和官网保持一致
- 支持搜索
- 支持多版本
- 可以使用使用 airflow 的 docs CI 脚本
缺点
- 要重新修改当前的翻译
- rst格式在国内可能没有markdown普及 会使得项目维护者数量变少(important很多项目都是因为缺少新的参与者导致最后走不下去)
欢迎大家补充优缺点, 欢迎使用 👍 表示赞成, 👎 表示反对
from airflow-doc-zh.
有的
from airflow-doc-zh.
的确 1.10.3 官网修改了很多内容,但是我们还没有解决多版本页面的问题,这样会导致新版本将旧版本覆盖掉的情况,这样对用户不太友好。我们针对某个版本的翻译也会丢失
from airflow-doc-zh.
对,所以我想大家讨论下。我现在觉得markdown写起来方便,但官方是用的rst,而且会根据代码生成API的解释,主要还是现在的zh/31.md 以及我刚翻译的zh/28.md 有大量的代码引用,在排版样式上和官网差异较大,特别是函数名,类名用反引号` 生成代码块会有滚动条,看起来不太方便
所以我们会考虑换用rst将格式统一吗?
多版本的问题可以部署在readthedoc平台上,我尝试把第一章部署了一下,这里 看效果,如果需要,我很乐意进一步调研下
from airflow-doc-zh.
@morefreeze 如果用 RST 的话,我就帮不上忙了,因为我没有配套的工具。靠你们了。
from airflow-doc-zh.
看看能不能拿 pandoc 转?
from airflow-doc-zh.
rst
好像用 python
就能直接转成 html
,同建议可考虑做成 rst
模式,airflow
的官网文档应该可以通过查看源的方式获取 rst
文档的原文。
不同版本是不是可以考虑做成不同的分支,master
是最新的版本,别的 branch
可以当作旧版本的翻译的备份
from airflow-doc-zh.
@zhongjiajie 的确 1.10.3 官网修改了很多内容,但是我们还没有解决多版本页面的问题,这样会导致新版本将旧版本覆盖掉的情况,这样对用户不太友好。我们针对某个版本的翻译也会丢失
我们正在考虑把它搬上 crowdin 来解决多版本问题。
from airflow-doc-zh.
Related Issues (14)
- 整体进度 HOT 8
- Github Pages 404 HOT 1
- 4.md 章节里面的翻译都是机翻,不需要翻译 HOT 2
- 这个是机器翻译的还是人工翻译的? HOT 1
- 建议合并PR的时候使用squash and merge HOT 1
- 统一不翻译Operator HOT 1
- 小错别字 HOT 1
- 为我们的翻译确定的一个基础的版本 HOT 2
- 文档不像原版文档有搜索功能 HOT 2
- 原版的引用代码在中文里一团乱 HOT 2
- 可以不使用ID作为文件名吗? HOT 3
- Airflow 文档导航栏的折叠效果 HOT 2
- Make the translation officially supported HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
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.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from airflow-doc-zh.