processing / processing/p5.js-web-editor

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

Open
#3,999 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Area: Documentation Enhancement Needs Discussion
Dominant language
JavaScript
Stars
1.7k
Forks
1.7k
Avg merge
3d 4h
Merged PRs (30d)
8

Description

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)

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Read contributor_docs/installation.md first and compare its current manual-first guidance with the Docker and manual setup options described in this issue. Update the installation section with a clear recommendation, reasons to choose each method, and any agreed decision guide or requirements; the documentation should let contributors choose a setup without resolving the tradeoffs themselves.

Written by the indexing model from the issue text.

Assessment

Tech stack
docker, mongodb, node.js
Domain
developer-experience, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.