PR#37: Clarifies when to use Docker CE or Podman in this repo - fedora-docs/documentation-contributors-guide

fedora-docs / documentation-contributors-guide

#37 Clarifies when to use Docker CE or Podman in this repo

Merged 2 years ago by pbokoc. Opened 2 years ago by dromo.

fedora-docs/ dromo/documentation-contributors-guide DockerOrPodman into master

Clarifies when to use Docker CE or Podman in this repo

d2015196 • 2 years ago

7c9c311

Clarifies when to use Docker CE or Podman in this repo

d2015196 • 2 years ago

6b9df7f

modules/contributing/pages/git.adoc

file modified

+2 -1

		`@@ -18,7 +18,8 @@`
		* git (`dnf install git`)
		`* The text editor of your choice`
		`* Basic terminal experience`
		- * (recommended) Podman (`dnf install podman`)
		+ * Podman if you use a Linux OS such as Fedora (`dnf install podman`) or Docker CE if you use macOS.
		`+`

		`NOTE: While this document was written with Fedora in mind, the steps below work on any operating system with git installed.`
		`See the https://git-scm.com/book/en/v2/Getting-Started-Installing-Git[git documentation] for more information on installing git on other operating systems.`

modules/contributing/pages/local-preview.adoc

file modified

+1 -1

		`@@ -9,7 +9,7 @@`

		`[NOTE]`
		`====`
		- Running both scripts requires a working [application]`Docker` setup. Each script may also ask for your `root` or user password.
		+ To run the scripts you'll need to install [application]`Podman` if using a Linux OS such as Fedora or [application]`Docker CE` if using macOS.
		`====`

		`== Using the regular Antora scripts`

modules/contributing/pages/prerequisites.adoc

file modified

+1 -1

		`@@ -10,4 +10,4 @@`

		* A plaintext editor such as [application]`vim`, [application]`emacs`, [application]`Atom`, [application]`VSCode`, etc., preferably with AsciiDoc syntax highlighting.
		* [application]`git` (see xref::git.adoc[Git for docs writers])
		- * [application]`Docker` or Podman for building and previewing your changes locally.
		+ * [application]`Podman` if you use a Linux OS such as Fedora or [application]`Docker CE` if you use macOS.

dromo commented 2 years ago

From looking at the build.sh script in the template repository, "fedora-docs/template", if on a Linux OS it needs either a Podman or Docker installation. As @pbokoc said we suggest Podman for these Linux OS users. However if a user is on macOS the script requires a Docker installation. I clarified this on any instance we mention tools Docker or Podman in this repo.