Documentation Revamp / Organisation
Dieses Issue hat noch niemand übernommen.
Bewertung
- Schwierigkeit
- 5/5
- Geschätzter Aufwand
- Über eine Woche
- Anfängerfreundlichkeit
- 20/100
- Issue-Typ
- Refactoring
- Klarheit
- Muss geklärt werden
- Aktivitätsstatus
- Veraltet
- Tech-Stack
- java
- Bereich
- build-system, developer-experience, documentation
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.
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
- Vorherrschende Sprache
- Java
- Sterne
- 497
- Forks
- 183
- Ø Merge
- 4 Std. 39 Min.
- Gemergte PRs (30 T.)
- 3
Beitragsleitfaden
Erste Schritte
- Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
- Forken Sie das Repository und arbeiten Sie in einem Branch.
- Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.
Mehr aus processing/processing4
-
bug
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 64/100
processing/processing4#1554 · 1 Kommentar ·
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 76/100
processing/processing4#1515 · 1 Reaktion ·
-
bug
Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 55/100
processing/processing4#1573 ·
-
startup error Offen
Schwierigkeit 4/5 3-5 Tage Anfängerfreundlichkeit 25/100
processing/processing4#1569 · 7 Kommentare ·
-
Binaries under bin directory lack executable permissions for the snap and .deb packages for Linux Offenbug
processing/processing4#1567 · 3 Kommentare · 1 Reaktion · 1 zugewiesene Person ·
Alle Issues in processing/processing4
Ähnliche Issues
-
executions.Query — startDate and timeRange filters are sent with inverted comparison operators Offenarea/plugin
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 75/100
kestra-io/plugin-kestra#190 ·
-
litertlm-android AAR ships no consumer ProGuard rules → "mid == null" SIGABRT in minified apps Offen
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 70/100
google-ai-edge/LiteRT-LM#3739 ·
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 75/100
integra-team-red/meet-map#249 ·
-
[Studio][Bug] Cancelled create-user dialog keeps the password and admin switch for the next attempt Offen
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 75/100
apache/rocketmq-dashboard#5064 ·
-
Consent portal: creating a duplicate Purpose shows a generic error instead of "already exists" Offen
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 75/100
wso2/dpdp-accelerator#287 ·