processing / processing/processing4

Documentation Revamp / Organisation

Offen
#1,350 6 Kommentare 1 Reaktion 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

documentation
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
Suggested actions
  • Get rid of any instances where the developer has to make sure repositories live next to each other on disk
  • Migrate processing-doclet into the processing-website and make it run on build
    • Research further into migrating / replicating the custom doclet into Gradle and make it run w gradle
  • Delete processing-doclet repo
  • Migrate processing-examples into the processing-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.txt back into the processing4 repo
  • Add an automatic update trigger for processing4-javadoc to the processing4 repo release action (or migrate processing4-javadoc into the processing4 repo)
    • Migrate Javadoc from Ant to Gradle
Related PRs/Issues/Other documentation

#1204

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Ö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

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.