Giter Club home page Giter Club logo

Comments (59)

fengmk2 avatar fengmk2 commented on March 29, 2024 2

领 passport

from egg.

popomore avatar popomore commented on March 29, 2024 1

@zhoudaqing 好的,我们尽快

from egg.

fengmk2 avatar fengmk2 commented on March 29, 2024

直接 README 吧,多语言使用 README.zh-CN.md 类似这样的。

from egg.

atian25 avatar atian25 commented on March 29, 2024

先在 README + docs 下.

后面再配置个 travis gitbook 推到 pages.

from egg.

atian25 avatar atian25 commented on March 29, 2024

https://github.com/esdoc/esdoc

from egg.

atian25 avatar atian25 commented on March 29, 2024

progit 的文档翻译不知道是如何同步的, 下面有个百分比.
而且翻译者如何知道下次更新是基于哪个点开始? 难道每次都记录上次的起始基点?

from egg.

fengmk2 avatar fengmk2 commented on March 29, 2024

尽量中英文文档修改同时提交。

from egg.

atian25 avatar atian25 commented on March 29, 2024

Api docs 这个 @popomore 你来搞下?

from egg.

popomore avatar popomore commented on March 29, 2024

eggjs/egg-core#10 (comment) 这里有个 jsdoc 需要优化

from egg.

popomore avatar popomore commented on March 29, 2024

文档怎么搞还没结论,是不是就做个页面其他放在 egg docs 目录?

from egg.

atian25 avatar atian25 commented on March 29, 2024
  • guide 文档通过 markdown 构建
  • api 用 jsdoc 或 esdoc 构建

需讨论的是,

  • docs下加一个 site 目录放官网的页面文件
  • ghpage
  • 单独的仓库用于自动构建发布

from egg.

atian25 avatar atian25 commented on March 29, 2024

docs 下的 guide 如何多语言呢?

from egg.

popomore avatar popomore commented on March 29, 2024

就是按目录分语言

docs
|- zh-CN
`- en

from egg.

popomore avatar popomore commented on March 29, 2024

自动构建的话直接 push 到 https://github.com/eggjs/eggjs.org

from egg.

crazybear avatar crazybear commented on March 29, 2024

请问各位大大,什么时候发布文档呢,眼巴巴的看了好几天了

from egg.

popomore avatar popomore commented on March 29, 2024

大概 10月,还在写

from egg.

zhoudaqing avatar zhoudaqing commented on March 29, 2024

@fengmk2 @atian25 @popomore 文档能不能完善一下? 刚刚使用egg很痛苦,靠猜和看源代码太痛苦了,希望能尽快完善一下。

from egg.

popomore avatar popomore commented on March 29, 2024

先写中文 https://eggjs.org/zh-cn/guide/

from egg.

popomore avatar popomore commented on March 29, 2024

cc @HiuYanChong

from egg.

popomore avatar popomore commented on March 29, 2024

目录结构已更新

from egg.

18601673727 avatar 18601673727 commented on March 29, 2024

催更..

from egg.

fengmk2 avatar fengmk2 commented on March 29, 2024

插件 README 文档规范

  • 必须包含以下章节
    • 依赖说明(无则省略)
    • 开启插件
    • 使用场景
    • 详细配置(无则省略)
    • 单元测试(无则省略,例如 schedule 如何触发)
    • 提问交流: 请到 egg issues 异步交流。

示例:

from egg.

jiangzhuo avatar jiangzhuo commented on March 29, 2024

催更..

from egg.

atian25 avatar atian25 commented on March 29, 2024

@18601673727 @jiangzhuo 你们可以先看下 https://github.com/eggjs/egg/blob/master/SPECIFICATION.zh_CN.md

from egg.

fengmk2 avatar fengmk2 commented on March 29, 2024

领 tracer

from egg.

fengmk2 avatar fengmk2 commented on March 29, 2024

领 httpclient

from egg.

gxcsoccer avatar gxcsoccer commented on March 29, 2024

领 cluster & 插件

from egg.

shaoshuai0102 avatar shaoshuai0102 commented on March 29, 2024

领 logger

from egg.

popomore avatar popomore commented on March 29, 2024

开始写 loader

from egg.

popomore avatar popomore commented on March 29, 2024

直播贴 https://cnodejs.org/topic/5870e9da04dcf9a706a745f0

from egg.

fengmk2 avatar fengmk2 commented on March 29, 2024

示例代码都放到 https://github.com/eggjs/examples

from egg.

dead-horse avatar dead-horse commented on March 29, 2024

https://github.com/sparanoid/chinese-copywriting-guidelines

from egg.

shaoshuai0102 avatar shaoshuai0102 commented on March 29, 2024

认领 本地开发和 debug

from egg.

popomore avatar popomore commented on March 29, 2024

领框架开发

from egg.

fengmk2 avatar fengmk2 commented on March 29, 2024

接手单元测试

from egg.

gxcsoccer avatar gxcsoccer commented on March 29, 2024

领 passport/userservice(userrole)

from egg.

mansonchor avatar mansonchor commented on March 29, 2024

「访问 MYSQL 要不我认领下?今天内提交PR

@jtyjty99999 确认一下你开始写了没?」

@jtyjty99999 快写完了,我帮忙补充和review吧

from egg.

popomore avatar popomore commented on March 29, 2024

文档现在可访问 https://eggjs.org/zh-cn/intro/egg-and-koa.html 但还需要优化

  • 支持默认 lang,现在默认是中文,就是 /xx == /zh-cn/xx。如果某个语言文档默认缺失使用默认文档补全。
  • 侧栏选中当前项
  • url 去掉 .html 后缀
  • 支持 toc
  • 支持多语言选择
  • 静态文件支持 hash

from egg.

atian25 avatar atian25 commented on March 29, 2024

域名要不要做个 cn.eggjs.org 的映射?

from egg.

fengmk2 avatar fengmk2 commented on March 29, 2024

@atian25 没必要子域名,太丑

from egg.

popomore avatar popomore commented on March 29, 2024

What's egg

from egg.

popomore avatar popomore commented on March 29, 2024

practice 可以改成 tutorials,这个感觉比较常用

from egg.

atian25 avatar atian25 commented on March 29, 2024

eslint

from egg.

atian25 avatar atian25 commented on March 29, 2024

少了个 static

from egg.

popomore avatar popomore commented on March 29, 2024

部署先等这个做完,先隐藏 #241

from egg.

popomore avatar popomore commented on March 29, 2024

支持默认 lang,现在默认是中文,就是 /xx == /zh-cn/xx。如果某个语言文档默认缺失使用默认文档补全。

先把这个做好就可以推广了

from egg.

atian25 avatar atian25 commented on March 29, 2024

README 也需要修改下里面的链接

from egg.

popomore avatar popomore commented on March 29, 2024

static 是啥?

from egg.

atian25 avatar atian25 commented on March 29, 2024

文档里面有 egg-static 了么?

from egg.

atian25 avatar atian25 commented on March 29, 2024
  • 框架章节有个链接失效 example/framework eggjs/examples#8
  • boilerplate 列表介绍?
  • loader 增加如何定制 this.model.xx 的示例?

from egg.

atian25 avatar atian25 commented on March 29, 2024

#257

from egg.

atian25 avatar atian25 commented on March 29, 2024

from egg.

atian25 avatar atian25 commented on March 29, 2024
  • [ ]『什么是 egg』 需要优化,更老少皆宜一点。

另外,可以加入一些『渐进式』的描述 #268 (comment)

@popomore

from egg.

popomore avatar popomore commented on March 29, 2024

之后需要增加的 #276

from egg.

popomore avatar popomore commented on March 29, 2024

这个 issue 没问题的话先关了,后面文档补充单独提 issue

from egg.

popomore avatar popomore commented on March 29, 2024

@atian25 boilerplate 需要介绍?

from egg.

atian25 avatar atian25 commented on March 29, 2024

不用了, 现在文档里面感觉也没地方塞.

或者在 egg-init 那里列举下官方的骨架就好了.

from egg.

atian25 avatar atian25 commented on March 29, 2024

@eggjs/core any plan on this?

from egg.

atian25 avatar atian25 commented on March 29, 2024

missing passport document

from egg.

Related Issues (20)

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.