Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve Docker usage documentation #40

Merged
merged 1 commit into from
May 22, 2020
Merged

Improve Docker usage documentation #40

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 2 additions & 5 deletions README.md
View file
Open in desktop
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