From 8a62f0c8fd72277b5c8d1e0c8ce5756a404ff120 Mon Sep 17 00:00:00 2001 From: PhoeniXAbhisheK Date: Mar 04 2019 06:01:42 +0000 Subject: Updated setup details, and correctly formatted the old document(development.rst) --- diff --git a/docs/setup/development.rst b/docs/setup/development.rst index 78e1204..760535f 100644 --- a/docs/setup/development.rst +++ b/docs/setup/development.rst @@ -9,18 +9,22 @@ Using Docker The project comes with a Dockerfile that allows easy deployment of a web server. -1. Install Docker (refer `this `_) and Docker Compose (refer `this `_) on your machine. +#. Install Docker (refer `this `_) and Docker Compose (refer `this `_) on your machine. -For platform specific installation guidelines: + For platform specific installation guidelines: -:macOS: `Docker Desktop `_ (Docker Compose is included as part of desktop installs.) -:Windows: `Docker Desktop `_ (Docker Compose is included as part of desktop installs.) -:CentOS: `Docker CE `_ -:Debian: `Docker CE `_ -:Fedora: `Fedora Developer Portal `_ -:Ubuntu: `Docker CE `_ + :macOS: `Docker Desktop `_ (Docker Compose is included as part of desktop installs.) + :Windows: `Docker Desktop `_ (Docker Compose is included as part of desktop installs.) + :CentOS: `Docker CE `_ + :Debian: `Docker CE `_ + :Fedora: `Fedora Developer Portal `_ + :Ubuntu: `Docker CE `_ -2. Run the client secret generation script:: +#. Fork the repository, then clone using ``ssh``. For steps to setup ``ssh``, refer `this `_ :: + + git clone "ssh://git@pagure.io/forks//fedora-commops/fedora-happiness-packets.git" + +#. Run the client secret generation script:: ./generate_client_secrets.sh @@ -37,7 +41,7 @@ Access the shell of the Docker container by running ``docker-compose exec web sh The test suite can be run by running the ``t`` script, which runs the tests with the appropriate testing settings and provides a coverage report. In order to run the script, simply type ``./t`` in the Docker container's shell. -Integration tests are run via the following command: ``./manage.py test -v 2 -p integration_test*.py --settings=happinesspackets.settings.tsting`` +Integration tests are run via the following command: ``docker-compose exec web ./manage.py test -v 2 -p integration_test*.py --settings=happinesspackets.settings.tsting`` Alternatives to Docker diff --git a/docs/setup/development_windows.rst b/docs/setup/development_windows.rst index 5f95903..cea923b 100644 --- a/docs/setup/development_windows.rst +++ b/docs/setup/development_windows.rst @@ -19,7 +19,7 @@ Setting up the development environment ======================================== #. Fork the `current repository `_ to your profile. -#. Clone this forked repository to your system using Git with the following command:: +#. Clone this forked repository (ssh method is recommended, the steps can be found `here `_) to your system using Git with the following command:: git clone "https://pagure.io/forks//fedora-commops/fedora-happiness-packets.git"