Skip to content
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

Deploy pull request changes to Netlify so we can preview the devguide #463

Open
Mariatta opened this Issue Feb 12, 2019 · 9 comments

Comments

Projects
None yet
4 participants
@Mariatta
Copy link
Member

Mariatta commented Feb 12, 2019

Original thread in core-workflow mailing list:
https://mail.python.org/archives/list/core-workflow@python.org/thread/5FBBRHIWXWRCGHHKCU7WQR3MNFEX4647/

It would be great if we can have a preview of the docs on the internet (without having to manually build it ourselves locally). This is useful for reviewers who want to view the changed documentation.

Service like netlify allows us to deploy the pull request changes for preview.

Before integrating this for docs.python.org, it would be great to try this out in devguide.

cc @matrixise

@Mariatta

This comment has been minimized.

Copy link
Member Author

Mariatta commented Feb 12, 2019

GitMate.io thinks possibly related issues are #133 (Update Devguide about pull request commit documentation.), #104 (Should an issue be created first, before the Pull Request?), #215 (Editing pull request: Can we rebase instead of merge?), #325 (Add tricks for the Pull Requests review?), and python/core-workflow#39 (checking code style for pull request).

@ewdurbin

This comment has been minimized.

Copy link
Member

ewdurbin commented Feb 12, 2019

I believe this was successful for pypa/setuptools, as was setup back at PyCon 2018 sprints. Let me know if you need any assistance and I can try to recall what went into that process.

@Mariatta

This comment has been minimized.

Copy link
Member Author

Mariatta commented Feb 12, 2019

I think I got it setup? 😅
test PR #464
https://deploy-preview-464--cpython-devguide.netlify.com/

But I had signed up using a personal account on netlify. Perhaps I should transfer this to you or to the PSF?

@ewdurbin

This comment has been minimized.

Copy link
Member

ewdurbin commented Feb 12, 2019

I'm already acting as the Owner for pypa/setuptools with two other administrators.

Happy to accept the transfer and add your user as an Admin. If possible I'd love to recruit one other user for the role.

@Mariatta

This comment has been minimized.

Copy link
Member Author

Mariatta commented Feb 12, 2019

Sounds great! I tried looking into netlify and couldn't really figure out how to transfer or add other admins 😅 Let me know what to do here.

@willingc

This comment has been minimized.

Copy link
Collaborator

willingc commented Feb 13, 2019

I'm happy to act as another Admin for the dev guide @Mariatta @ewdurbin unless there is someone else that wishes to do so. I already have the netlify toolchain on my system.

@matrixise

This comment has been minimized.

Copy link
Collaborator

matrixise commented Feb 14, 2019

@Mariatta I could work on this issue with the doc

@ewdurbin

This comment has been minimized.

Copy link
Member

ewdurbin commented Feb 14, 2019

@Mariatta can you share what if any particular settings in netlify were needed to create the initial setup? I can go ahead and create a new project and add the new admins.

@Mariatta

This comment has been minimized.

Copy link
Member Author

Mariatta commented Feb 14, 2019

I went to netlify, and added python/devguide repo.
Then in the build settings:
Build command: sphinx-build -n -W -q -b html -d _build/doctrees . _build/html
Publish directory: _build/html
Branch: master.

I think that's all.

Under Build & deploy > Continuous Deployment > Deploy contexts, just ensure the Deploy previews: "Automatically build deploy previews for all pull requests" is selected (I think it was by default)

Thanks.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.