Skip to content

Document a simpler way to run snekbox#68

Merged
MarkKoz merged 4 commits into
masterfrom
feat/doc/57/docker-run-cmd
Mar 23, 2020
Merged

Document a simpler way to run snekbox#68
MarkKoz merged 4 commits into
masterfrom
feat/doc/57/docker-run-cmd

Conversation

@MarkKoz
Copy link
Copy Markdown
Contributor

@MarkKoz MarkKoz commented Mar 23, 2020

Resolves #57 by adding a docker run command to README.md. Also included some other minor documentation improvements. See commit messages for more info.

MarkKoz added 3 commits March 23, 2020 09:09
The current run instructions are geared towards developers. A simpler
way to run snekbox is to start a container with `docker run` via the
image published on Docker Hub.

Resolves #57
Makes the Markdown less cluttered when editing it.
As convenient as it may be, it is redundant to list out the config in
the docs. It also may fall out of sync with the actual config should
someone forget to update the docs.
@MarkKoz MarkKoz added type: feature New feature or request status: needs review Author is waiting for someone to review and approve area: docs Adds or updates documentation priority: 3 - low labels Mar 23, 2020
@MarkKoz MarkKoz requested a review from a team as a code owner March 23, 2020 16:32
@MarkKoz MarkKoz requested review from dementati and manusaurio March 23, 2020 16:32
Copy link
Copy Markdown

@kwzrd kwzrd left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Excellent, I like it.

@MarkKoz MarkKoz merged commit 496226e into master Mar 23, 2020
@MarkKoz MarkKoz deleted the feat/doc/57/docker-run-cmd branch March 23, 2020 16:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area: docs Adds or updates documentation priority: 3 - low status: needs review Author is waiting for someone to review and approve type: feature New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Improve non-developer access

2 participants