ember-fastboot/ember-cli-fastboot

Add some better docs to signpost that you shouldn't run `ember serve --environment=production`

Open

#922 opened on Jun 8, 2023

View on GitHub
 (0 comments) (1 reaction) (0 assignees)JavaScript (853 stars) (163 forks)batch import
good first issue

Description

I recently had a conversation in Discord where it became obvious that the "insider knowledge" that ember-cli's server isn't fit for production use wasn't readily apparent.

I asked where would be good places to make this explicit in the docs and there are two recommendations:

that last example is particularly bad because it hints that you might use ember-cli for something "serious" 🙈

We need to make this as obvious as possible, even going so far to put it as a WARNING as visually large as possible.

Contributor guide

Tech stack
javascript
Domain
documentationbackend
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
95
Research direction
Review the two documentation sections linked in the issue: 'Fastboot App Server Configuration' and 'Running'. In each, add a prominent warning box stating that `ember serve environment=production` is not intended for production use. Consider using markdown blockquotes or bold text for emphasis. After making changes, verify the formatting renders correctly.