Documentation Revamp / Organisation
还没有人认领这个 Issue。
评估
- 难度
- 5/5
- 预计耗时
- 一周以上
- 新手友好度
- 20/100
- Issue 类型
- 重构
- 描述清晰度
- 需要澄清
- 活跃度
- 停滞
- 技术栈
- java
调研方向
首先阅读相关 issue #1204,并梳理 processing-website、processing-doclet、processing-examples、processing4 和 processing4-javadocs 当前如何交换生成的内容。在选择迁移路径之前,检查现有的 build 和 release 步骤。完成的标准是:各 repository 不再需要手动将内容放在同一位置或维护只读副本,并且文档化的生成和更新操作已实现自动化或整合。
由索引模型根据 Issue 内容生成。
描述
The examples and some of the documentation around Processing are kind of all over the place
The Goal
Have one repo where documentation lives: processing-website
The current issues
- processing-website
- updates processing4's
keywords.txtbased on content generated through processing-doclet - has to manually update
content/examplesand it is unclear that this data is partially read-only, the script applies processing-examples on top -
content/contributionsis also readonly and is no longer compatible with the new processing-contributions pipeline
- updates processing4's
- processing4-javadocs does not automatically update with each release
- processing-examples does not contain the images/livesketches/metadata that the website needs.
- processing-doclet is a separate repo that will create the parsed javadoc comments for the website
Suggested actions
- Get rid of any instances where the developer has to make sure repositories live next to each other on disk
- Migrate
processing-docletinto theprocessing-websiteand make it run on build- Research further into migrating / replicating the custom doclet into Gradle and make it run w gradle
- Delete
processing-docletrepo - Migrate
processing-examplesinto theprocessing-website- Tested, still need to figure out how to merge the folders whilst keeping history
- Archive
processing-examples - Remove all read-only files from
processing-website - Move the generation of
keywords.txtback into theprocessing4repo - Add an automatic update trigger for
processing4-javadocto theprocessing4repo release action (or migrateprocessing4-javadocinto theprocessing4repo)- Migrate Javadoc from Ant to Gradle
Related PRs/Issues/Other documentation
#1204
- 主要语言
- Java
- 星标
- 497
- 派生
- 183
- 平均合并
- 4 小时 39 分钟
- 30 天内合并 PR
- 3
贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
processing/processing4 的其他 Issue
-
bug
难度 2/5 1-3 小时 新手友好度 64/100
processing/processing4#1554 · 1 条评论 ·
-
难度 2/5 1-3 小时 新手友好度 76/100
processing/processing4#1515 · 1 个 reaction ·
-
bug
难度 3/5 1-2 天 新手友好度 55/100
processing/processing4#1573 ·
-
startup error 未关闭
难度 4/5 3-5 天 新手友好度 25/100
processing/processing4#1569 · 7 条评论 ·
-
Binaries under bin directory lack executable permissions for the snap and .deb packages for Linux 未关闭bug
processing/processing4#1567 · 3 条评论 · 1 个 reaction · 已指派 1 人 ·
查看 processing/processing4 的全部 Issue
相似的 Issue
-
area/plugin
难度 2/5 1-3 小时 新手友好度 75/100
kestra-io/plugin-kestra#190 ·
-
难度 2/5 1-3 小时 新手友好度 70/100
google-ai-edge/LiteRT-LM#3739 ·
-
bug
难度 2/5 1-3 小时 新手友好度 75/100
-
难度 2/5 1-3 小时 新手友好度 75/100
integra-team-red/meet-map#249 ·
-
[Studio][Bug] Cancelled create-user dialog keeps the password and admin switch for the next attempt 未关闭
难度 2/5 1-3 小时 新手友好度 75/100
apache/rocketmq-dashboard#5064 ·