silverstripe / silverstripe/developer-docs

Recommend a VM as the primary solution to get started with SilverStripe

Open
#33 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

affects/v4 complexity/low impact/medium type/docs
Dominant language
No language data
Stars
7
Forks
74
Avg merge
1d 14m
Merged PRs (30d)
6

Description

Setting up your own webserver on a host system is no longer necessary, given the speed and usability improvements in virtualisation layers. Our main gettgin started guide in the docs still recommends installing on the host: https://docs.silverstripe.org/en/4/getting_started/installation/

The tutorials are a bit clearer (VMs as the first option), but could also be a bit clearer in their recommendation: https://www.silverstripe.org/learn/lessons/v4/up-and-running-setting-up-a-local-silverstripe-dev-environment-1.

We should provide a consistent and advice here, and clearly mark out "advanced use cases" to avoid confusing beginners. And not treat our guides as "related content", but rather have one way to install our product.

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

Review the getting started installation guide and the linked local SilverStripe development tutorial, comparing how each presents VM-based setup and host installation. Align their recommendations, clearly identify advanced use cases, and provide one consistent installation path for beginners.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.