Skip to content

Update docs for Podman support - #345

Merged
crazy-max merged 3 commits into
crazy-max:masterfrom
signed-log:podman_note
Apr 28, 2021
Merged

Update docs for Podman support#345
crazy-max merged 3 commits into
crazy-max:masterfrom
signed-log:podman_note

Conversation

@signed-log

Copy link
Copy Markdown
Contributor

Running diun on Podman (default container runtime on RHEL, CentOS...) needs a workaround to work, this doc change treats that

@signed-log
signed-log requested a review from crazy-max as a code owner April 26, 2021 21:28

@crazy-max crazy-max left a comment

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

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

Was starting to review but I think it should be on a dedicated page named "Podman" under Installation section.

Comment thread docs/faq.md Outdated
Comment thread docs/faq.md Outdated
Comment thread docs/install/docker.md Outdated
@signed-log

Copy link
Copy Markdown
Contributor Author

I think so too, will do that

@crazy-max

Copy link
Copy Markdown
Owner

@Stig124 If you want to test documentation locally you can use the following commands:

# Build mkdocs image
docker build -t mkdocs -f ./hack/docs.Dockerfile --target base .
# Run mkdocs image and watch for changes
docker run --rm -it -p 8000:8000 -v $(pwd):/docs mkdocs
# Open http://localhost:8000 on your browser

Running diun on Podman (default container runtime on RHEL, CentOS...)
needs a workaround to work, this doc change treats that

Separate Podman install page

Rolled back previous commit, added Podman page
@signed-log

Copy link
Copy Markdown
Contributor Author

And it is done

@signed-log

Copy link
Copy Markdown
Contributor Author

@Stig124 If you want to test documentation locally you can use the following commands:

# Build mkdocs image
docker build -t mkdocs -f ./hack/docs.Dockerfile --target base .
# Run mkdocs image and watch for changes
docker run --rm -it -p 8000:8000 -v $(pwd):/docs mkdocs
# Open http://localhost:8000 on your browser

This should definitely be part of the contributing docs as it is really useful

@crazy-max crazy-max left a comment

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

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

Overall lgtm minus small changes. Also I'm a little concerned about the TOC like:

##### Rootful (`root` user)

Can you make it less cumbersome?

Comment thread docs/install/docker.md Outdated
Comment thread docs/install/podman.md Outdated
Comment thread docs/install/podman.md Outdated
Comment thread docs/install/podman.md Outdated
Comment thread docs/install/podman.md Outdated
Comment thread docs/install/podman.md Outdated
Comment thread docs/install/podman.md Outdated
Comment thread mkdocs.yml Outdated
signed-log and others added 2 commits April 28, 2021 22:40
Co-authored-by: CrazyMax <1951866+crazy-max@users.noreply.github.com>
Co-authored-by: CrazyMax <1951866+crazy-max@users.noreply.github.com>

@crazy-max crazy-max left a comment

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

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

LGTM thanks!

@crazy-max
crazy-max merged commit 810d451 into crazy-max:master Apr 28, 2021
@crazy-max crazy-max mentioned this pull request Apr 28, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants