Installation Documentation: Clarify When to Use Docker vs. Manual Setup

Aperta
  • Qualcosa non va?
#3,999 4 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 4 giorni

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
45/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
docker, mongodb, node.js
Ambito
developer-experience, documentation

Direzione di ricerca

Leggi prima contributor_docs/installation.md e confronta le indicazioni attuali, che danno priorità alla configurazione manuale, con le opzioni di configurazione con Docker e manuale descritte in questa issue. Aggiorna la sezione sull'installazione con una raccomandazione chiara, i motivi per scegliere ciascun metodo ed eventuali linee guida decisionali o requisiti concordati; la documentazione dovrebbe permettere ai contributors di scegliere una configurazione senza dover risolvere autonomamente i compromessi.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

Area: Documentation Enhancement Needs Discussion
Increasing Access

The current Installation Documentation suggests a Manual and Docker Installation method to setup a local environment of the p5.js editor, and currently encourages new contributors to try the Manual Installation first. However, for newer contributors who might not be used to using the terminal or backend setup processes, Docker can be a more reliable and less error-prone method because it runs the environment in containers with preconfigured dependencies.

Feature enhancement details
Overall Changes

This issue proposes updating the documentation to:

  • Provide clearer guidance on when each installation method is recommended

  • Better explain why a contributor might prefer one approach over the other

  • Potentially recommend Docker as the default for new contributors, while still supporting manual installation for advanced or debugging workflows.

Example Change

Instead of encouraging manual installation first, the docs could clearly describe when each option is preferable.

Here are two ways it could look like:

Docker Installation (recommended for most contributors)

  • Fastest way to get a working development environment
  • No need to install Node, MongoDB, or other dependencies locally
  • Avoids version conflicts
  • Consistent setup across different operating systems

Manual Installation (recommended if you need more control)

  • Helpful for debugging dependency issues directly
  • Potentially easier for contributors who are already comfortable managing Node.js/Mongo environments in the terminal
  • Prefer not to run Docker on local machine

OR

Before you dive in, there are two ways to install the project locally:

Docker Installation (recommended for most contributors)
Docker provides a fully configured development environment with all dependencies (Node.js, MongoDB, etc.) running inside containers. This avoids version conflicts and provides a consistent setup across machines.

Manual Installation (recommended for advanced users or debugging)
Manual installation gives you direct control over dependencies on your system. This can be helpful for debugging or if you prefer to manage Node.js and MongoDB locally.

Next Steps
  • Discuss whether Docker should become the recommended default
  • Update the Development Installation documentation accordingly
  • Reorganize the installation section to guide contributor decision-making
  • What other information/formatting could be added that could be helpful? (i.e system requirements or storage size, creating a small decision guide)
Lingua principale
JavaScript
Stelle
1.7k
Fork
1.7k
Merge medio
7g 1h
PR unite (30g)
13

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di processing/p5.js-web-editor

Tutte le issue di processing/p5.js-web-editor

Issue simili

Altre issue su JavaScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.