PR#153: Changed prerequisite from Python3 to Python2 in documentation. - fedora-commops/fedora-happiness-packets

fedora-commops / fedora-happiness-packets

#153 Changed prerequisite from Python3 to Python2 in documentation.

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

fedora-commops/ sanjana11147/fedora-happiness-packets python_documentation into master

Changed prerequisite from Python3 to Python2 in documentation.

Sanjana • 5 years ago

b291798

docs/setup/development_windows.rst

file modified

+6 -1

		`@@ -10,7 +10,12 @@`
		`You will need the following programs installed on your system before proceeding with the setup.`

		#. `Git <https://git-scm.com/>`_
		- #. `Python <https://www.python.org/downloads/>`_ (version >= 3.5)
		+ #. `Python <https://www.python.org/downloads/release/python-2716/>`_ (version = 2.7)
		`+`
		`+ .. note::`
		+ We will be soon migrating to `Python <https://www.python.org/downloads/>`_ (version >=3.5) as Python 2.7 will reach end of support in 2020. More details can be found `here <https://pagure.io/fedora-commops/fedora-happiness-packets/issue/150>`_.
		`+`
		`+`
		#. `Docker Desktop for Windows <https://hub.docker.com/editions/community/docker-ce-desktop-windows>`_ (Download, installation, and run instructions available)
		#. Docker Compose (Docker Compose is included as part of Docker Desktop, but if you still need to download it, you can do it from `here <https://docs.docker.com/compose/install/>`_)

sanjana11147 commented 5 years ago

Changed the prerequisite in the setup instructions documentation.

This change will help the users to install fedora happiness packets without any conflicts.

Tested: Locally. Passed test.docs.sh

jflory7 commented 5 years ago

@sanjana11147 Thanks for this PR! :tada:

I should have mentioned this before, but I meant to use a note directive in Sphinx. There is a special syntax to render an additional note:

Check out this PDF for more info about Sphinx markup / syntax.

Could you make a small change to use the note directive instead?

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

5 years ago

1 new commit added