API Documentation Detail
还没有人认领这个 Issue。
评估
- 难度
- 5/5
- 预计耗时
- 一周以上
- 新手友好度
- 25/100
- Issue 类型
- 文档
- 描述清晰度
- 需要澄清
- 活跃度
- 停滞
- 技术栈
- graphql
- 领域
- api, databases, documentation, testing
调研方向
首先盘点所请求的文档领域：数据库迁移和转储、db 命名约定、buildQuery、wrangler.toml 和 scraper 脚本、REST 和 GraphQL 端点，以及测试。开始编写之前，先查看现有的文档站点和文档页面位置。完成的标准是，文档化的工作流覆盖从数据库变更到端点测试的过程，其中包括错误代码、示例、已更改的文件以及需要关注的区域。
由索引模型根据 Issue 内容生成。
描述
DB Design / Changes:
- db migrations + process of implementation of a new db change + documentation for all moving parts (db dump, process of running migration file on local instance, testing scraper - where to find script)
- db naming conventions
- buildQuery
Scraper:
- documentation on understanding wrangler.toml files, how scrapers work, what to expect from them
Endpoint:
- error codes and meanings GOOD PRACTICE - along with endpoint info.
- rest endpoint
- all files changed
- areas of focus, things to look out for
- what a typical change entails
- graphql
- difference between rest and graphql
- example of implementation
- where to test on docs page
Testing:- testing throughout the process [db change -> endpoint]
- 主要语言
- MDX
- 星标
- 0
- 派生
- 1
- 平均合并
- 23 天 5 小时
- 30 天内合并 PR
- 1
环境准备
这个项目没有提供开发容器、Dockerfile 或贡献指南，环境需要你自己搭建：先看它的 README，通用步骤见我们的新手贡献指南。
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
icssc/docs 的其他 Issue
-
难度 1/5 1 小时以内 新手友好度 45/100
-
OG Images 404可能重新可做 @alexanderl19 于 641 天前认领，目前没有进行中的 PR。 未关闭bug
-
Deploys & Staging Previews可能重新可做 @andrew-wang0 于 643 天前认领，目前没有进行中的 PR。 未关闭
-
Add Page Descriptions可能重新可做 @alexanderl19 于 698 天前认领，目前没有进行中的 PR。 未关闭
-
Centralized Calendar API Reference and Architecture可能已有人在做 @spicecat 于 867 天前认领。 未关闭docs:addition
相似的 Issue
-
难度 2/5 1-3 小时 新手友好度 78/100
维护者通常 5 天内回复
-
area-multitenancy area-security p1-recommended priority-high technical-debt
难度 2/5 1 小时以内 新手友好度 75/100
维护者通常 1 天内回复
-
[Bug]: REST API URL starting with "http" but no scheme (e.g. httpbin.org/get) is not given an http:// prefix可能已有人在做 @ItsDeadlyProgrammer 今天认领。 未关闭
难度 2/5 1-3 小时 新手友好度 68/100
appsmithorg/appsmith#42471 · 1 条评论 ·
维护者通常 2 天内回复
-
enhancement
难度 2/5 1-3 小时 新手友好度 72/100
fossasia/visdom-dev#77 ·
维护者通常 4 天内回复
-
bug
难度 2/5 1-3 小时 新手友好度 63/100
FriendsofECCE/ECCE#519 ·