Documentation Revamp / Organisation
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Idoneità per principianti
- 20/100
- Tipo di issue
- Refactoring
- Chiarezza
- Da chiarire
- Stato di attività
- Ferma
- Stack tecnologico
- java
Direzione di ricerca
Inizia leggendo l’issue correlata #1204 e mappando il modo in cui processing-website, processing-doclet, processing-examples, processing4 e processing4-javadocs scambiano attualmente i contenuti generati. Esamina i passaggi esistenti di build e release prima di scegliere un percorso di migrazione. Il lavoro sarà considerato completato quando i repository non richiederanno più la co-localizzazione manuale né copie in sola lettura e le azioni documentate di generazione e aggiornamento saranno automatizzate o consolidate.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
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
- Lingua principale
- Java
- Stelle
- 497
- Fork
- 183
- Merge medio
- 4h 39m
- PR unite (30g)
- 3
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di processing/processing4
-
bug
Difficoltà 2/5 1-3 ore Idoneità per principianti 64/100
processing/processing4#1554 · 1 commento ·
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 76/100
processing/processing4#1515 · 1 reazione ·
-
bug
Difficoltà 3/5 1-2 giorni Idoneità per principianti 55/100
processing/processing4#1573 ·
-
startup error Aperta
Difficoltà 4/5 3-5 giorni Idoneità per principianti 25/100
processing/processing4#1569 · 7 commenti ·
-
Binaries under bin directory lack executable permissions for the snap and .deb packages for Linux Apertabug
processing/processing4#1567 · 3 commenti · 1 reazione · 1 assegnatario ·
Tutte le issue di processing/processing4
Issue simili
-
documentation
Difficoltà 2/5 1-3 ore Idoneità per principianti 65/100
inu-appcenter/memorIN-backend#288 ·
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 65/100
-
frontend maui-pilot pilot-ask question
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
-
executions.Query — startDate and timeRange filters are sent with inverted comparison operators Apertaarea/plugin
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
kestra-io/plugin-kestra#190 ·