#135 Updated the setup docs(Windows) to suggest user to use `ssh` during cloning the repo.
Merged 5 months ago by jflory7. Opened 5 months ago by phoenixabhishek.

file modified
+14 -10

@@ -9,18 +9,22 @@

  

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

  

- 1. Install Docker (refer `this <https://docs.docker.com/install/>`_) and Docker Compose (refer `this <https://docs.docker.com/compose/install/>`_) on your machine.

+ #. 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:

+     For platform specific installation guidelines:

  

- :macOS: `Docker Desktop <https://docs.docker.com/docker-for-mac/install/>`_ (Docker Compose is included as part of desktop installs.)

- :Windows: `Docker Desktop <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/>`_

- :Debian: `Docker CE <https://docs.docker.com/install/linux/docker-ce/debian/>`_

- :Fedora: `Fedora Developer Portal <https://developer.fedoraproject.org/tools/docker/docker-installation.html>`_

- :Ubuntu: `Docker CE <https://docs.docker.com/install/linux/docker-ce/ubuntu/>`_

+     :macOS: `Docker Desktop <https://docs.docker.com/docker-for-mac/install/>`_ (Docker Compose is included as part of desktop installs.)

+     :Windows: `Docker Desktop <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/>`_

+     :Debian: `Docker CE <https://docs.docker.com/install/linux/docker-ce/debian/>`_

+     :Fedora: `Fedora Developer Portal <https://developer.fedoraproject.org/tools/docker/docker-installation.html>`_

+     :Ubuntu: `Docker CE <https://docs.docker.com/install/linux/docker-ce/ubuntu/>`_

  

- 2. Run the client secret generation script::

+ #. Fork the repository, then clone using ``ssh``. For steps to setup ``ssh``, refer `this <https://docs.pagure.org/pagure/usage/first_steps.html>`_ ::

+ 

+     git clone "ssh://git@pagure.io/forks/<user_name>/fedora-commops/fedora-happiness-packets.git"

+ 

+ #. Run the client secret generation script::

  

      ./generate_client_secrets.sh

  

@@ -37,7 +41,7 @@

  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

@@ -19,7 +19,7 @@

  ========================================

  

  #. Fork the `current repository <https://pagure.io/fedora-commops/fedora-happiness-packets>`_ 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 <https://docs.pagure.org/pagure/usage/first_steps.html>`_) to your system using Git with the following command::

  

      git clone "https://pagure.io/forks/<user_name>/fedora-commops/fedora-happiness-packets.git"

  

  1. What is a summary of your change?
    The current document provides both approaches(http and ssh) for users to clone the repository.
    However, based on some recent new-user experience it was found that users get an error while pushing changes when ssh method is not used.
    Change is based out of this suggestion

  2. Why is this change helpful?
    This new change suggests that ssh is the recommended way to go forward when cloning the repository for the setup.
    This will prevent future new-users to avoid the current issue faced.

  3. Any specific details to consider?
    These can also be updated on the other docs as well.

  4. What do you think is the outcome of this change?
    The user, on initial steps itself, will use ssh approach with the repository, and will be able to execute tasks(push/pull) successfully.

@jflory7 please review if this addresses the issue that is faced by our new users.

These are nitpicks, but please add whitespace before the starting parentheses (repository (SSH method is) and remove whitespace before the end parentheses (first_steps.html>_)`).

Hi @phoenixabhishek, thanks for the PR to add better clarity. :thumbsup:

These can also be updated on the other docs as well.

Do you think you can update the docs for both pages?

I feel like it might be better to avoid writing the same steps twice that don't change between Windows and UNIX. A way to make this page easier to maintain could be detailing only the differences from the main dev environment setup page. But I think this would be better in a different pull request.

For now, if you can also update the other page's instructions to keep these two in sync, that would be helpful too.

1 new commit added

  • update ssh details for cloning on setup
5 months ago

I feel like it might be better to avoid writing the same steps twice that don't change between Windows and UNIX. A way to make this page easier to maintain could be detailing only the differences from the main dev environment setup page. But I think this would be better in a different pull request.

Yes, we can have a new PR to address this issue.

For now, if you can also update the other page's instructions to keep these two in sync, that would be helpful too.

Okk, I'll do that :thumbsup: :thumbsup: :thumbsup: :thumbsup: :thumbsup:

1 new commit added

  • updated the docs for non-windows systems for using ssh
5 months ago

1 new commit added

  • document formatted for proper list numbers
5 months ago

rebased onto 8a62f0c

5 months ago

@jflory I've made the necessary changes currently.
Also, squashed multiple commits to one.

Please see if this is good to merge :smile: :smile: :smile: :smile: :smile:

@phoenixabhishek Looks good! Merging this in. :clapper:

Pull-Request has been merged by jflory7

5 months ago