From 6b9df7fbc7863ce36c5d193942f9bbca5e7ef44f Mon Sep 17 00:00:00 2001 From: d2015196 Date: Jun 03 2021 21:35:29 +0000 Subject: [PATCH 1/2] Clarifies when to use Docker CE or Podman in this repo --- diff --git a/modules/contributing/pages/git.adoc b/modules/contributing/pages/git.adoc index 1431764..9079f8b 100644 --- a/modules/contributing/pages/git.adoc +++ b/modules/contributing/pages/git.adoc @@ -18,7 +18,8 @@ To do anything else on this page, you'll want to have the following: * 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. diff --git a/modules/contributing/pages/local-preview.adoc b/modules/contributing/pages/local-preview.adoc index 5f328b9..f868563 100644 --- a/modules/contributing/pages/local-preview.adoc +++ b/modules/contributing/pages/local-preview.adoc @@ -9,7 +9,7 @@ To preview, run the `build.sh` script; this is the one that actually builds a lo [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 diff --git a/modules/contributing/pages/prerequisites.adoc b/modules/contributing/pages/prerequisites.adoc index ba98b87..ef99771 100644 --- a/modules/contributing/pages/prerequisites.adoc +++ b/modules/contributing/pages/prerequisites.adoc @@ -10,4 +10,4 @@ For larger updates or to contribute all-new documentation, you may also need: * 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 `Docker CE` if you use macOS. From 7c9c3111855aeb61ebd1a0d84908fc4d1ecc1e64 Mon Sep 17 00:00:00 2001 From: d2015196 Date: Jun 03 2021 21:43:07 +0000 Subject: [PATCH 2/2] Clarifies when to use Docker CE or Podman in this repo --- diff --git a/modules/contributing/pages/prerequisites.adoc b/modules/contributing/pages/prerequisites.adoc index ef99771..5b10490 100644 --- a/modules/contributing/pages/prerequisites.adoc +++ b/modules/contributing/pages/prerequisites.adoc @@ -10,4 +10,4 @@ For larger updates or to contribute all-new documentation, you may also need: * 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]`Podman` if you use a Linux OS such as Fedora or `Docker CE` if you use macOS. +* [application]`Podman` if you use a Linux OS such as Fedora or [application]`Docker CE` if you use macOS.