This document will make it easier for people on Windows to get started working on fedora-happiness-packets. Refer Issue #108
Hi @phoenixabhishek, content looks great! :thumbsup: However, building the docs produces a warning:
/home/jflory/git/fedora/commops/fedora-happiness-packets/docs/setup/development_windows.rst:1: WARNING: Title overline too short. ========================================= Setting up a development environment on Windows =========================================
Take a look at the Sphinx docs style guide, specifically the part about how to write headings.
Can you refactor your headings to match the format described by the style guide? This should fix the warning above too.
Metadata Update from @jflory7: - Pull-request tagged with: PASSED, needs changes, new change, type - docs, type - summer coding - Request assigned
Hi @jflory7 , I'll make the necessary changes. Also, can you please tell me what tests gave you the error..??? Because I did execute the test-dosc.sh command, but did't get any errors.
test-dosc.sh
1 new commit added
Fix for 'Title overline too short'
Hi @jflory7 , I'll make the necessary changes.
Thanks! :thumbsup:
Because I did execute the test-dosc.sh command, but did't get any errors.
I used the same script. However, I was using a Python virtual environment (venv) when I ran the script. Maybe we had different Sphinx versions. I use Pipenv to manage my dependencies (see this Fedora Magazine article for more info about using it). There is a Pipfile already inside the docs/ directory for convenient use with Pipenv.
docs/
@jflory7 the changes are done, please review.
Did you still need to run this step? The script in the repository is an executable file now, so this step should be okay to omit.
This hyperlink is formatted incorrectly. The underscore should go after the tickmark to render as a hyperlink.
Remove the whitespace between the tickmarks here. The whitespace causes these to render incorrectly instead of monospace text.
Same feedback here as line #60.
This is a nitpick, but could you place this page immediately after the other development environment page? I think it is better to keep them ordered together.
@phoenixabhishek Thanks for making the change. Everything builds successfully for me now. :thumbsup: I left some line comments with specific feedback. A few things were not rendering correctly.
markup and spacing fixes
doc sequence changed
@jflory7 I've made the changes. I don't know why I messed up the hyperlink markups, I clearly did it correctly for links before it. It was bad on my part, sorry for that. :disappointed: :disappointed: :disappointed: :disappointed: :disappointed: I'll try to be better with proof-reading the files. :sweat_smile: :sweat_smile: :sweat_smile: :sweat_smile: :sweat_smile:
rebased onto e4a73a100d2dfae2826d98175105323668bd3652
Metadata Update from @jflory7: - Pull-request untagged with: needs changes
@jflory7 I've made the changes.
Awesome, thanks @phoenixabhishek! :thumbsup:
Before merging this, I have a final request. Could you please rebase and squash your commits into one commit? This helps keep the git changelog tidy. If you have never rebased before, see these two articles for help:
If you need additional guidance, don't hesitate to ask for help.
It was bad on my part, sorry for that.
No worries. This is one reason we practice peer review for pull requests. It is too easy to make a mistake! :sweat_smile:
Also, for the documentation test-docs.sh script, it builds the HTML on your device like it appears on our docs website. After you run the script, you should have a folder like this: docs/_build/html. Inside that folder are the HTML pages. You can use that to proof your documentation and make sure it renders like you expect. This is how I review docs pull requests. :smile:
test-docs.sh
docs/_build/html
Sure. Thank you for the feedback. I'll get on it right away :smile: :smile: :smile: :smile: :smile:
rebased onto 6c1e32131e04af170fe0cb787c1f5274d026790a
@jflory7 DONE :rocket: :rocket: :rocket: :rocket: :rocket:
@phoenixabhishek Great, thanks! :100: This is all set. Merging. :clapper:
Pull-Request has been merged by jflory7
@jflory7 Thank you :smiley: :smiley: :smiley: :smiley: :smiley:
@phoenixabhishek In the documentation for windows setup you have mentioned
chmod -x generate_client_secrets.sh
which makes file not executable. Rather it should be
chmod +x generate_client_secrets.sh
Could you make the necessary change in original file?
@alishapapun Thanks a lot for pointing this out. Made PR #140 for this. Thanks again :thumbsup: :thumbsup: :thumbsup: :thumbsup: :thumbsup:
This document will make it easier for people on Windows to get started working on fedora-happiness-packets.
Refer Issue #108