PR#117: Add reference links for installing docker and docker-compose - fedora-commops/fedora-happiness-packets

fedora-commops / fedora-happiness-packets

#117 Add reference links for installing docker and docker-compose

Merged 5 years ago by jflory7. Opened 5 years ago by shraddhaag.

fedora-commops/ shraddhaag/fedora-happiness-packets modify-setup-development-docs into master

Add links for installing Docker and Docker Compose on different platforms

ShraddhaAg • 5 years ago

a587539

Add reference links for installing docker and docker-compose

ShraddhaAg • 5 years ago

e5ee9f4

docs/setup/development.rst

file modified

+11 -1

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

		`The project comes with a Dockerfile that allows easy deployment of a web server.`

		`- 1. Install Docker and Docker Compose on your machine.`
		+ 1. Install Docker (refer `this <https://docs.docker.com/install/>`_) and Docker Compose (refer `this <https://docs.docker.com/compose/install/>`_) on your machine.
		`+`
		`+ For platform specific installation guidelines:`
		`+`
		+ :macOS: `Docker Dekstop <https://docs.docker.com/docker-for-mac/install/>`_ (Docker Compose is included as part of desktop installs.)
		+ :Windows: `Docker Dekstop <https://docs.docker.com/docker-for-windows/install/>`_ (Docker Compose is included as part of desktop installs.)
		+ :CentOS: `Docker CE <https://docs.docker.com/install/linux/docker-ce/centos/>`_. For Docker Compose refer the above link.
		+ :Debian: `Docker CE <https://docs.docker.com/install/linux/docker-ce/debian/>`_. For Docker Compose refer the above link.
		+ :Fedora: `Docker CE <https://docs.docker.com/install/linux/docker-ce/fedora/>`_. For Docker Compose refer the above link.
		+ :Ununtu: `Docker CE <https://docs.docker.com/install/linux/docker-ce/ubuntu/>`_. For Docker Compose refer the above link.
		`+`
		`2. Run the client secret generation script::`

		`./generate_client_secrets.sh`

shraddhaag commented 5 years ago

References issue #100

Q - What is a summary of your change?
A - Added the links to installing Docker and Docker Compose.

Q - Why is this change helpful?
A - The links are a good helping hand for beginners and will help in reducing the time taken for setting up the project.

Note: The change passed the test-docs.sh successfully.

jflory7 commented 5 years ago

@shraddhaag Super, thanks for the addition! :thumbsup:

One thought. These links are specific to Ubuntu machines. It's fair to assume other people might be using a different environment or operating system. I suggest one or both of these changes:

Add link for general install instructions (not dependent on specific operating system)
Move the existing links into the previous paragraph with a mention they are Ubuntu-specific instructions

Could you make one or both of these changes please?

Metadata Update from @jflory7:
- Pull-request tagged with: improvement, needs changes, type - docs, type - summer coding
- Request assigned

5 years ago

shraddhaag commented 5 years ago

@jflory7 I chose these links because right in the beginning they provide options to switch to whichever Linux DIstribution the user might be using. But giving general install instructions makes sense.

I'll integrate the changes as suggested! Thanks for the review :)

1 new commit added