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
-
documentation
難度 2/5 1-3 小時 新手友好度 65/100
inu-appcenter/memorIN-backend#288 ·
-
難度 2/5 1-3 小時 新手友好度 65/100
-
frontend maui-pilot pilot-ask question
難度 2/5 1-3 小時 新手友好度 75/100
-
難度 2/5 1-3 小時 新手友好度 75/100
-
area/plugin
難度 2/5 1-3 小時 新手友好度 75/100
kestra-io/plugin-kestra#190 ·