Summary

Write new documentation page explaining how to set up a development environment on a Windows machine

Background

Now that our documentation is live, we can add new documentation about the project and to help others get started. One suggestion in #100 was a Windows-specific guide to set up a development environment.

This ticket requires some reading up on the Sphinx documentation toolchain. We use Sphinx to create our own docs (see an example page here). You need to write a new page in the ReStructuredText markup language to publish in our documentation. Use the other development environment page as a reference for writing a new one.

Details

A pull request to complete this ticket includes the following:

New page with Windows-specific instructions for setting up fedora-happiness-packets development environment
Link added to index.rst so page appears on homepage
Docs should build successfully without errors (use the test-docs.sh script to test changes)

Outcome

Easier for people on Windows to get started working on fedora-happiness-packets

jflory7 commented Feb 25, 2019

@phoenixabhishek I assigned this issue to you since you were interested in working on it. Is the ticket clear to you for what work needs to be done?

phoenixabhishek commented Feb 25, 2019

@phoenixabhishek I assigned this issue to you since you were interested in working on it. Is the ticket clear to you for what work needs to be done?

Thanks, yes its clear.
If I need any help, I'll ask in this thread itself. :smile: :smile: :smile: :smile: :smile:

Metadata Update from @jflory7:
- Issue tagged with: PASSED

Feb 25, 2019

phoenixabhishek commented Feb 26, 2019

@jflory7 can I request a snap of what is the expected output when ./manage.py test -v 2 -p integration_test*.py --settings=happinesspackets.settings.tsting is run.

I am getting output, but it doesn't look right to me.
This is my O/P:

jflory7 commented Feb 26, 2019

@phoenixabhishek I replied in #100. Please avoid double-posting the same comment in multiple tickets so the conversation does not repeat itself across multiple tickets.

phoenixabhishek commented Feb 26, 2019

@jflory7 Okk, got it.
Apologies.

phoenixabhishek commented Feb 27, 2019

@jflory7 PR #119 is made for the documentation, please review :smile:
This is what it looks like