processing / processing/processing4
Documentation Revamp / Organisation
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Java
- Sterne
- 494
- Forks
- 183
- Ø Merge
- 4 Std. 39 Min.
- Gemergte PRs (30 T.)
- 3
Beschreibung
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
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne damit, das zugehörige Issue #1204 zu lesen und abzubilden, wie processing-website, processing-doclet, processing-examples, processing4 und processing4-javadocs derzeit generierte Inhalte austauschen. Überprüfe die bestehenden Build- und Release-Schritte, bevor du einen Migrationspfad auswählst. Als erledigt gilt die Aufgabe, wenn die Repositories keine manuelle gemeinsame Ablage oder schreibgeschützten Kopien mehr erfordern und die dokumentierten Generierungs- und Aktualisierungsaktionen automatisiert oder zusammengeführt sind.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- java
- Bereich
- build-system, developer-experience, documentation
- Issue-Typ
- Refactoring
- Schwierigkeit
- 5/5
- Geschätzter Aufwand
- Über eine Woche
- Aktivitätsstatus
- Veraltet
- Klarheit
- Muss geklärt werden
- Anfängerfreundlichkeit
- 20/100