Skip to content

include instructions to preview changes in CONTRIB #744

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 31, 2016

Conversation

ajarara
Copy link

@ajarara ajarara commented Aug 31, 2016

These instructions detail how to build and preview changes the contributor has made as it would appear on the actual site.

This is very easy to setup provided you have python3 (http.server is called SimpleHTTPServer in python2). This seems to be a good quick way to test files visually (which would avoid screw ups like mine).

@ajarara
Copy link
Author

ajarara commented Sep 8, 2016

I would also be willing to add an additional section using docker to automate something like this (although this is rather trivial, I don't know how you build the live site exactly).

So I could instead modify this section to first show how to preview changes if the contributor has docker set up, followed by a manual set up.

Example additions would look something like this, and would be addressed in another pull request:

Previewing your changes with docker

Simply run

docker pull python-guide-sphinx

then

docker run python-guide-sphinx [ARG]

The instance will watch the directory for changes and then automatically rebuild and display on port .

Manually previewing changes

@kennethreitz kennethreitz merged commit 14ad6c7 into realpython:master Oct 31, 2016
@kennethreitz
Copy link
Contributor

no docker :)

@ajarara ajarara deleted the add-preview-instructions branch May 2, 2017 22:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants