Skip to content

Commit

Permalink
Improve Docker usage documentation
Browse files Browse the repository at this point in the history
--rm removes the container right after running it, without the need to cleanup
-u $(id-u) runs as the current user, removing the need to modify permissions after
  • Loading branch information
ccremer authored May 4, 2020
1 parent a025f54 commit 2aefc00
Showing 1 changed file with 2 additions and 5 deletions.
7 changes: 2 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,18 +51,15 @@ You can mount directory with charts under `/helm-docs` within container.
Print generated documentation to stdout rather than modifying READMEs:

```bash
docker run -v "$(pwd):/helm-docs" jnorwood/helm-docs:latest --dry-run
docker run --rm -v "$(pwd):/helm-docs" -u $(id -u) jnorwood/helm-docs:latest --dry-run
```

Overwrite READMEs within mounted directory:

```bash
docker run -v "$(pwd):/helm-docs" jnorwood/helm-docs:latest
docker run --rm -v "$(pwd):/helm-docs" -u $(id -u) jnorwood/helm-docs:latest
```

Notice: You may need to fix permissions to the created files.


# Building from source

Notice that you need to have build chain toolkit for given platform and golang installed.
Expand Down

0 comments on commit 2aefc00

Please sign in to comment.