Skip to content

docs: Debugging - Correctly starting DMS#3654

Merged
georglauterbach merged 1 commit intomasterfrom
docs/debugging-correctly-start-dms
Nov 25, 2023
Merged

docs: Debugging - Correctly starting DMS#3654
georglauterbach merged 1 commit intomasterfrom
docs/debugging-correctly-start-dms

Conversation

@polarathene
Copy link
Copy Markdown
Member

@polarathene polarathene commented Nov 24, 2023

Description

Previously suggested in Aug 2023: #3482

@georglauterbach is managing the v13 release, so I've set the milestone to v13.1 in case this misses the v13 release window.


Presently there is a fairly clear and early mention of this advice in the docs:

### Get Up and Running
!!! danger "Using the Correct Commands For Stopping and Starting DMS"
**Use `docker compose up / down`, not `docker compose start / stop`**. Otherwise, the container is not properly destroyed and you may experience problems during startup because of inconsistent state.
Using `Ctrl+C` **is not supported either**!

This PR just adds a more verbose variant to explain the problem better and place it in a location users are more likely to land at when troubleshooting (because who reads docs in full these days? 😆 ).

Preview

image


Reference

List of --force-recreate being used / suggested to troubleshoot (not filtered to when it was the solution):

@polarathene polarathene added kind/improvement Improve an existing feature, configuration file or the documentation area/documentation labels Nov 24, 2023
@polarathene polarathene added this to the v13.1.0 milestone Nov 24, 2023
@polarathene polarathene self-assigned this Nov 24, 2023
@github-actions
Copy link
Copy Markdown
Contributor

Documentation preview for this PR is ready! 🎉

Built with commit: 1c3d507

@polarathene polarathene mentioned this pull request Nov 25, 2023
4 tasks
@georglauterbach georglauterbach merged commit 7d1fcb7 into master Nov 25, 2023
@georglauterbach georglauterbach deleted the docs/debugging-correctly-start-dms branch November 25, 2023 09:57
@georglauterbach georglauterbach modified the milestones: v13.1.0, v13.0.0 Nov 25, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/documentation kind/improvement Improve an existing feature, configuration file or the documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants