PR#152: Modified README.md to remove referrences to Docker - fedora-docs/quick-docs

fedora-docs / quick-docs

#152 Modified README.md to remove referrences to Docker

Merged 4 years ago by mattdm. Opened 4 years ago by mowest.

fedora-docs/ mowest/quick-docs WIP-mainpgedit into master

Modified README.md to remove referrences to Docker

mowestusa • 4 years ago

d075884

README.md

file modified

+6 -8

		`@@ -38,7 +38,12 @@`

		`NOTE: Please note that if you reference pages from other repositories, such links will be broken in this local preview as it only builds this repository. If you want to rebuild the whole Fedora Docs site, please see [the Fedora Docs build repository](https://pagure.io/fedora-docs/docs-fp-o/) for instructions.`

		`- Both scripts use docker, so please make sure you have it installed on your system. Please see below for instructions.`
		`+ Both scripts use podman in F30 and above. Please make sure you have podman installed on your system.`
		`+`
		`+ ### Installing podman on Fedora`
		+ ```
		`+ $ sudo dnf install podman`
		+ ```

		`To build and preview the site, run:`

		`@@ -47,10 +52,3 @@`
		```

		`The result will be available at http://localhost:8080`
		`-`
		`- ### Installing docker on Fedora`
		`-`
		- ```
		`- $ sudo dnf install docker`
		`- $ sudo systemctl start docker && sudo systemctl enable docker`
		- ```

mowest commented 4 years ago

From what I understand since F30 the ./build.sh and ./preview.sh both run on podman not "docker." So I removed the references to "docker" and replaced them with "podman" in the main README.md file. I was unsure if I needed to add a "systemctl" command for "podman" like what had been there for "docker."

mattdm commented 4 years ago

Looks good to me. No need for the systemctl command because podman is daemonless, so that's fine.

Pull-Request has been merged by mattdm

4 years ago

dromo commented 2 years ago

Hey I know this PR is from a while back but I think you can use docker as well if you are on Fedora. The build.sh script can handle both. If on the other hand, you are using MacOS it can only handle Docker. Perhaps we should specify this in the README and also leave the how-to-install instructions for Docker on Fedora if user decides to.

dromo commented 2 years ago

If you look at the script under case user is on a Linux OS which I believe includes Fedora it checks for both Podman and Docker.

pbokoc commented 2 years ago

@dromo The script originally used only Docker and later switched to Podman, using Docker as a fallback if Podman isn't installed. Podman is the recommended tool, so I'd say it's fine to leave it undocumented and only talk about Podman in instructions. If someone insists on Docker, they probably know what they're doing, so they can check the script and see the if/else block.

dromo commented 2 years ago

@pbokoc Got it. What if they are using MacOS? From the script they should install Docker.