Skip to content

Commit

Permalink
docs: proof of Concept docker/roadmap#102
Browse files Browse the repository at this point in the history
  • Loading branch information
ivorscott committed Jun 28, 2020
1 parent 0cc135b commit 6a60c23
Showing 1 changed file with 18 additions and 5 deletions.
23 changes: 18 additions & 5 deletions README.md
Expand Up @@ -9,18 +9,22 @@ Beginners need tutorials for docker. To get one from docker currently they need
[GITHUB ISSUE](https://github.com/docker/roadmap/issues/102)

### Go Docs

Run the following command in the project root.

```
docker run -v $(pwd):/go/src -p 8080:8080 ivorsco77/godocs
docker run -v $(pwd):/go/src -p 8080:8080 ivorsco77/godocs
```

Then navigate to http://localhost:8080/pkg/tutor/

### Usage

dockertutor has 3 tutorials:

1) docker
2) docker-compose
3) swarm
1. docker
2. docker-compose
3. swarm

First initialize your workspace then switch between tutorials with `--category` or `-c`

Expand All @@ -32,9 +36,18 @@ dockertutor init
dockertutor -c docker
```

### Tests
### Tests

Run tests

```
go tests -v ./...
```

### UX Issues

Currently digging into ways to improve the user experience when working with lessons that require example files and file modification, in addition to running docker commands against them. My latest merge is getting close. https://github.com/ivorscott/dockertutor/pull/16

### Contact

ivor@devpie.io

0 comments on commit 6a60c23

Please sign in to comment.