PR#3: Drop references to Docker/docker - fedora-docs/websites

fedora-docs / websites

#3 Drop references to Docker/docker

Merged 3 years ago by pbokoc. Opened 3 years ago by miabbott.

fedora-docs/ miabbott/websites fix_mag_script into master

drop references to Docker/docker

Micah Abbott • 3 years ago

49aa047

setup-docker: fix magazine script extension

Micah Abbott • 3 years ago

b4d3569

modules/ROOT/nav.adoc

file modified

+1 -1

		`@@ -1,4 +1,4 @@`
		`- * xref:setup-docker.adoc[Getting Set Up (Docker)]`
		`+ * xref:setup-docker.adoc[Getting Set Up (Podman)]`
		`* xref:setup.adoc[Getting Set Up (old method)]`
		`* xref:fedora-release.adoc[Fedora Beta/GA Release]`
		`* xref:newcontent.adoc[Creating New Content]`

modules/ROOT/pages/fedora-release.adoc

file modified

+1 -1

		`@@ -7,7 +7,7 @@`
		`[NOTE]`
		`====`
		`This assume you have a working setup already. See the other documents (e.g. the`
		`- one using Docker to get a development environment working) to get set up. Also,`
		`+ one using Podman to get a development environment working) to get set up. Also,`
		`if using a container-based environment, *ensure that the image you're using`
		reflects the latest `Dockerfile` in the root of the repository.*
		`====`

modules/ROOT/pages/setup-docker.adoc

file modified

+8 -15

		`@@ -1,23 +1,16 @@`
		`- = Getting Set Up (using Docker)`
		`+ = Getting Set Up (using Podman)`
		`Rick Elrod`
		`:page-authors: {author}`

		`== Preliminary Notes`

		`It is now easier to get started on developing the Fedora Websites with the use`
		`- of Docker (or Podman).`
		`+ of Podman.`

		We ship a `Dockerfile` which will install dependencies into an image
		`for you, so all you are left to do is mount the site as a volume, pull`
		`translations, and start the development server.`

		`- [NOTE]`
		`- ====`
		- The documentation here refers to `docker`, but our fairly simple use
		- of it means that things are likely to work with `podman` with little
		`- modification.`
		`- ====`
		`-`
		`== Building the container image`

		`First clone the repository:`
		`@@ -30,11 +23,11 @@`
		`(You may instead clone your fork of it, or add your fork as a second`
		`remote later on.)`

		`- Now ensure Docker is running and run:`
		`+ Now build the container image with:`

		`[source,bash]`
		`----`
		`- sudo docker build -t fedora-websites .`
		`+ sudo podman build -t fedora-websites .`
		`----`

		`This will generate a container image for you to use.`
		`@@ -46,10 +39,10 @@`

		`[source,bash]`
		`----`
		`- sudo docker run -it --rm -v "$(pwd):/opt/:z" fedora-websites ./scripts/pull-translations.sh`
		`+ sudo podman run -it --rm -v "$(pwd):/opt/:z" fedora-websites ./scripts/pull-translations.sh`
		`----`

		- Notice here that we are mounting a volume (`-v`) in Docker which
		+ Notice here that we are mounting a volume (`-v`) via podman which
		`points to our check-out of the repository. We're referring to the`
		`fedora-websites` image created above, and calling the
		`./scripts/pull-translations.sh` script from within it.
		`@@ -61,7 +54,7 @@`

		`[source,bash]`
		`----`
		`- sudo docker run -it --rm -v "$(pwd):/opt/:z" fedora-websites python ./scripts/pull-magazine.sh`
		`+ sudo podman run -it --rm -v "$(pwd):/opt/:z" fedora-websites python ./scripts/pull-magazine.py`
		`----`

		`== Running the development server`
		`@@ -70,7 +63,7 @@`

		`[source,bash]`
		`----`
		`- sudo docker run -it --rm -v "$(pwd):/opt/:z" -p 5000:5000 fedora-websites flask run --reload --host 0.0.0.0`
		`+ sudo podman run -it --rm -v "$(pwd):/opt/:z" -p 5000:5000 fedora-websites flask run --reload --host 0.0.0.0`
		`----`

		Note that we need `-p 5000:5000` so that we can access the development

miabbott commented 3 years ago

We are in the age of Fedora 32 where podman is the preferred
container runtime tool in the Fedora ecosystem. Let's promote this by
dropping references to Docker/docker from our instructions.