Comments (59)
领 passport
from egg.
@zhoudaqing 好的,我们尽快
from egg.
直接 README 吧,多语言使用 README.zh-CN.md 类似这样的。
from egg.
先在 README + docs 下.
后面再配置个 travis gitbook 推到 pages.
from egg.
https://github.com/esdoc/esdoc
from egg.
progit 的文档翻译不知道是如何同步的, 下面有个百分比.
而且翻译者如何知道下次更新是基于哪个点开始? 难道每次都记录上次的起始基点?
from egg.
尽量中英文文档修改同时提交。
from egg.
Api docs 这个 @popomore 你来搞下?
from egg.
eggjs/egg-core#10 (comment) 这里有个 jsdoc 需要优化
from egg.
文档怎么搞还没结论,是不是就做个页面其他放在 egg docs 目录?
from egg.
- guide 文档通过 markdown 构建
- api 用 jsdoc 或 esdoc 构建
需讨论的是,
- docs下加一个 site 目录放官网的页面文件
- ghpage
- 单独的仓库用于自动构建发布
from egg.
docs 下的 guide 如何多语言呢?
from egg.
就是按目录分语言
docs
|- zh-CN
`- en
from egg.
自动构建的话直接 push 到 https://github.com/eggjs/eggjs.org
from egg.
请问各位大大,什么时候发布文档呢,眼巴巴的看了好几天了
from egg.
大概 10月,还在写
from egg.
@fengmk2 @atian25 @popomore 文档能不能完善一下? 刚刚使用egg很痛苦,靠猜和看源代码太痛苦了,希望能尽快完善一下。
from egg.
先写中文 https://eggjs.org/zh-cn/guide/
from egg.
cc @HiuYanChong
from egg.
目录结构已更新
from egg.
催更..
from egg.
插件 README 文档规范
- 必须包含以下章节
- 依赖说明(无则省略)
- 开启插件
- 使用场景
- 详细配置(无则省略)
- 单元测试(无则省略,例如 schedule 如何触发)
- 提问交流: 请到 egg issues 异步交流。
示例:
from egg.
催更..
from egg.
@18601673727 @jiangzhuo 你们可以先看下 https://github.com/eggjs/egg/blob/master/SPECIFICATION.zh_CN.md
from egg.
领 tracer
from egg.
领 httpclient
from egg.
领 cluster & 插件
from egg.
领 logger
from egg.
开始写 loader
from egg.
直播贴 https://cnodejs.org/topic/5870e9da04dcf9a706a745f0
from egg.
示例代码都放到 https://github.com/eggjs/examples
from egg.
https://github.com/sparanoid/chinese-copywriting-guidelines
from egg.
认领 本地开发和 debug
from egg.
领框架开发
from egg.
接手单元测试
from egg.
领 passport/userservice(userrole)
from egg.
「访问 MYSQL 要不我认领下?今天内提交PR
@jtyjty99999 确认一下你开始写了没?」
@jtyjty99999 快写完了,我帮忙补充和review吧
from egg.
文档现在可访问 https://eggjs.org/zh-cn/intro/egg-and-koa.html 但还需要优化
- 支持默认 lang,现在默认是中文,就是 /xx == /zh-cn/xx。
如果某个语言文档默认缺失使用默认文档补全。 - 侧栏选中当前项
- url 去掉 .html 后缀
- 支持 toc
- 支持多语言选择
- 静态文件支持 hash
from egg.
域名要不要做个 cn.eggjs.org 的映射?
from egg.
@atian25 没必要子域名,太丑
from egg.
What's egg
from egg.
practice 可以改成 tutorials,这个感觉比较常用
from egg.
eslint
from egg.
少了个 static
from egg.
部署先等这个做完,先隐藏 #241
from egg.
支持默认 lang,现在默认是中文,就是 /xx == /zh-cn/xx。如果某个语言文档默认缺失使用默认文档补全。
先把这个做好就可以推广了
from egg.
README 也需要修改下里面的链接
from egg.
static 是啥?
from egg.
文档里面有 egg-static 了么?
from egg.
- 框架章节有个链接失效 example/framework eggjs/examples#8
- boilerplate 列表介绍?
- loader 增加如何定制
this.model.xx
的示例?
from egg.
from egg.
-
~
和^
的选择 @dead-horse
from egg.
- [ ]『什么是 egg』 需要优化,更老少皆宜一点。
另外,可以加入一些『渐进式』的描述 #268 (comment)
from egg.
之后需要增加的 #276
from egg.
这个 issue 没问题的话先关了,后面文档补充单独提 issue
from egg.
@atian25 boilerplate 需要介绍?
from egg.
不用了, 现在文档里面感觉也没地方塞.
或者在 egg-init 那里列举下官方的骨架就好了.
from egg.
@eggjs/core any plan on this?
from egg.
missing passport document
from egg.
Related Issues (20)
- extend/application.js空导出,导致接口返回404 HOT 1
- 文档链接显示错误
- 依照官网初始化项目 HOT 1
- eggjs处理服务端请求有超时时间吗 HOT 3
- 在 service 中 extends egg 暴露的 Service 项目无法启动 HOT 1
- egg-router-plus 根 router 应该支持正则 HOT 1
- 能否将依赖的urllib升级为3.25的系列,而不是现在的2.41.0 HOT 2
- 怎么在没有app上下文的文件中 获取config中的配置? HOT 4
- 使用 oxlint 代替 eslint HOT 5
- egg 运行一段时间后,就会退出 HOT 1
- Track Progress of PR #5332 Towards Merging into Master
- Follow-up on PR #5334: Allow to create httpClient from app
- Track merging PR #5336 into master branch
- 服务器 egg-scrips start 无法启动,一直提示文件找不到。但是本地能正常运行 HOT 5
- Track merging of PR #5339 into master
- Track bugfix for httpclient.safeCurl typing
- eggjs返回的响应头为什么是使用小写? HOT 4
- 初始化项目跑不起来 HOT 1
- 为什么在服务启动命令中添加参数在服务生命周期中获取不到? HOT 2
- enableH2 开启的时候使用 undici v6
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 egg.