Local-build-instructions #2922

arronlacey · 2022-12-23T12:48:03Z

Summary

Adds some documentation to build the Turing Way Book locally. Original instructions proposed via the Infrastructure group and written by @sgibson91, edited by @arronlacey

List of changes proposed in this PR (pull-request)

adds instructions to build the book locally with jupyter-book
gives rationale for using miniconda and envs

What should a reviewer concentrate their feedback on?

Everything looks ok?
Should we add anything else?

Acknowledging contributors

All contributors to this pull request are already named in the table of contributors in the README file.
The following people should be added to the table of contributors in the README file:

netlify · 2022-12-23T12:48:08Z

✅ Deploy Preview for the-turing-way ready!

Name	Link
🔨 Latest commit	`ce68087`
🔍 Latest deploy log	https://app.netlify.com/sites/the-turing-way/deploys/640b210e096227000882bcee
😎 Deploy Preview	https://deploy-preview-2922--the-turing-way.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

spotted a few places where new sentences weren't on a new line

sgibson91

Thanks for this @arronlacey! I have a few suggestions to clean up the language, and I think the second section needs to be more narrative style rather than bullet points.

book/website/community-handbook/local-build.md

sgibson91 · 2023-01-04T11:19:09Z

book/website/community-handbook/local-build.md

+
+## Step-by-step guide
+1. Install miniconda https://conda.io/projects/conda/en/latest/user-guide/install/index.html#regular-installation
+2. Run `conda init` in your terminal. You should see `(base)` in your prompt indicating that conda was successfully installed and you are now in it's base environment.


We maybe want to be explicit about "open your terminal app and run the conda init command"

Yes, i agree with this.
And to add to it, my cmd did not recognize the conda init, i had to use the Anaconda prompt(miniconda3) terminal to run it. I will suggest adding a clue to that.

Anaconda and miniconda are different installations. Are you sure you installed miniconda, as per the instructions? Did your machine already have anaconda installed before you started?

Yes, i followed the instruction for installation https://conda.io/projects/conda/en/latest/user-guide/install/index.html#regular-installation, I selected for windows.
No i never had the Anaconda on my machine.

Huh, ok. This is probably a "things are different on Windows" scenario, so we should have a nested bullet point here saying "on windows, do this instead"

Hi both - hopefully I've addressed the comments in this conversation in commit c3c7dda . Namely adding more narrative and the point about needing Anaconda prompt on Windows

Are you sure you pushed the narrative changes? I'm examining commit c3c7dda (#2922) but it looks pretty similar to me? I'm imagining that we get rid of the bullet points under "Why did we recommend using (mini)conda?"

ah I was looking at the wrong section - I added some very light touch edits on the build instructions in c3c7dda. Ok no problem I'll have a crack at the miniconda section.

2ca45fa is hopefully more what you had in mind, and the title is now in line with the toc

book/website/community-handbook/local-build.md

aleesteele · 2023-02-22T17:51:37Z

@sandygudie and @RealRichi3 - maybe this would be of interest for you all? We'd love to see if there instructions make sense for you all to build the book currently on your local machines. (Tagging @BatoolMM for awareness).

RealRichi3 · 2023-02-22T21:37:53Z

@sandygudie and @RealRichi3 - maybe this would be of interest for you all? We'd love to see if there instructions make sense for you all to build the book currently on your local machines. (Tagging @BatoolMM for awareness).

Alright @aleesteele, we'll look into it and make the necessary changes, thanks

RealRichi3 · 2023-02-23T18:52:14Z

@sandygudie and @RealRichi3 - maybe this would be of interest for you all? We'd love to see if there instructions make sense for you all to build the book currently on your local machines. (Tagging @BatoolMM for awareness).

@aleesteele i went through the guide and it looks really good, although i have an issue.

Under the section Why did we recommend using miniconda, it talked about the importance of virtual environments, but the guide doesn't show how to setup the virtual environment for the local build.
Does this mean miniconda handles the creation of virtual environment?

RealRichi3 · 2023-02-23T19:02:55Z

Another question @aleesteele, should we go ahead and add the changes suggested by @sgibson91 ?

sgibson91 · 2023-02-23T19:35:15Z

Does this mean miniconda handles the creation of virtual environment?

Yes, the step conda create creates a virtual environment and conda activate makes sure all future commands are run inside of it.

RealRichi3 · 2023-02-23T20:54:21Z

Does this mean miniconda handles the creation of virtual environment?

Yes, the step conda create creates a virtual environment and conda activate makes sure all future commands are run inside of it.

Oh, i understand better now, thanks @sgibson91

RealRichi3 · 2023-02-23T22:57:49Z

@aleesteele, the guide is okay, i was able to setup the project build locally

samkitk · 2023-02-26T16:52:59Z

The instructions work for me as well and were super helpful :)

sandygudie

Welldone @arronlacey

I was able to build the Jupterbook successfully, I also dropped a couple of comments.

book/website/community-handbook/local-build.md

Co-authored-by: Sarah Gibson <44771837+sgibson91@users.noreply.github.com>

aleesteele

Well done @arronlacey @RealRichi3 @samkitk @RealRichi3! 🚀

Co-authored-by: Goodnews Sandy <54219127+sandygudie@users.noreply.github.com>

book/website/_toc.yml

book/website/community-handbook/local-build.md

Co-authored-by: Sarah Gibson <44771837+sgibson91@users.noreply.github.com>

sgibson91

This looks great to me now. Thank you @arronlacey!

book/website/community-handbook/local-build.md

Co-authored-by: Sarah Gibson <44771837+sgibson91@users.noreply.github.com>

arronlacey · 2023-03-10T14:33:31Z

Thank you @sgibson91, @sandygudie, @RealRichi3 @aleesteele @samkitk for working together on this.

arronlacey added 3 commits December 23, 2022 12:07

jupyter local build first draft

e8158e7

put local-build.md into consistency section

98db30d

put local-build.md back into it's own section

26e6374

pr-triage bot added the PR: unreviewed label Dec 23, 2022

arronlacey requested review from sgibson91 and aleesteele December 23, 2022 12:48

arronlacey added 4 commits December 23, 2022 12:55

fixes bad latin 🤞

bc6beac

typo and more latin fixes

a319810

new sentences -> new line

7fe1a43

spotted a few places where new sentences weren't on a new line

minor formatting

9105356

sgibson91 reviewed Jan 4, 2023

View reviewed changes

aleesteele mentioned this pull request Jan 30, 2023

Planning Documentation for Infrastructure Maintainers #2809

Open

aleesteele mentioned this pull request Feb 22, 2023

Update instructions for building book locally on Windows system #1754

Open

malvikasharan mentioned this pull request Feb 27, 2023

2023 GSoC discussion issue at the Exploration Phase #2978

Open

sandygudie reviewed Mar 2, 2023

View reviewed changes

book/website/community-handbook/local-build.md Outdated Show resolved Hide resolved

book/website/community-handbook/local-build.md Outdated Show resolved Hide resolved

arronlacey and others added 6 commits March 7, 2023 10:01

Update book/website/community-handbook/local-build.md

5ff312d

Co-authored-by: Sarah Gibson <44771837+sgibson91@users.noreply.github.com>

Update book/website/community-handbook/local-build.md

5c8889d

Co-authored-by: Sarah Gibson <44771837+sgibson91@users.noreply.github.com>

Update book/website/community-handbook/local-build.md

7235e9c

Co-authored-by: Sarah Gibson <44771837+sgibson91@users.noreply.github.com>

Update book/website/community-handbook/local-build.md

e2b80e0

Co-authored-by: Sarah Gibson <44771837+sgibson91@users.noreply.github.com>

Update book/website/community-handbook/local-build.md

9934f82

Co-authored-by: Sarah Gibson <44771837+sgibson91@users.noreply.github.com>

Update book/website/community-handbook/local-build.md

72b51b5

Co-authored-by: Sarah Gibson <44771837+sgibson91@users.noreply.github.com>

arronlacey and others added 3 commits March 7, 2023 10:03

Update book/website/community-handbook/local-build.md

c55160d

Co-authored-by: Sarah Gibson <44771837+sgibson91@users.noreply.github.com>

Update book/website/community-handbook/local-build.md

8e8eae3

Co-authored-by: Sarah Gibson <44771837+sgibson91@users.noreply.github.com>

Update book/website/community-handbook/local-build.md

531d3bb

Co-authored-by: Sarah Gibson <44771837+sgibson91@users.noreply.github.com>

aleesteele approved these changes Mar 7, 2023

View reviewed changes

pr-triage bot added PR: reviewed-approved and removed PR: unreviewed labels Mar 7, 2023

da5nsy mentioned this pull request Mar 9, 2023

May 2023 Book Dash Project Ideas #2988

Open

Update book/website/community-handbook/local-build.md

3190328

Co-authored-by: Goodnews Sandy <54219127+sandygudie@users.noreply.github.com>

pr-triage bot added PR: unreviewed and removed PR: reviewed-approved labels Mar 9, 2023

arronlacey and others added 2 commits March 9, 2023 14:45

Update book/website/community-handbook/local-build.md

123015d

Co-authored-by: Goodnews Sandy <54219127+sandygudie@users.noreply.github.com>

added more narrative to section 2

c3c7dda

sgibson91 reviewed Mar 9, 2023

View reviewed changes

book/website/_toc.yml Show resolved Hide resolved

sgibson91 reviewed Mar 9, 2023

View reviewed changes

book/website/community-handbook/local-build.md Outdated Show resolved Hide resolved

sgibson91 reviewed Mar 9, 2023

View reviewed changes

book/website/community-handbook/local-build.md Outdated Show resolved Hide resolved

arronlacey and others added 3 commits March 9, 2023 20:30

Update book/website/community-handbook/local-build.md

344f1a6

Co-authored-by: Sarah Gibson <44771837+sgibson91@users.noreply.github.com>

narrative conda changes, _toc title match

2ca45fa

properly formatted bullet points

258e632

sgibson91 approved these changes Mar 10, 2023

View reviewed changes

book/website/community-handbook/local-build.md Outdated Show resolved Hide resolved

pr-triage bot added PR: reviewed-approved and removed PR: unreviewed labels Mar 10, 2023

Update book/website/community-handbook/local-build.md

841883d

Co-authored-by: Sarah Gibson <44771837+sgibson91@users.noreply.github.com>

pr-triage bot added PR: unreviewed and removed PR: reviewed-approved labels Mar 10, 2023

Update book/website/community-handbook/local-build.md

ce68087

Co-authored-by: Sarah Gibson <44771837+sgibson91@users.noreply.github.com>

arronlacey merged commit c85a53a into main Mar 10, 2023

arronlacey deleted the local-build-instructions branch March 10, 2023 14:33

pr-triage bot added PR: merged and removed PR: unreviewed labels Mar 10, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Local-build-instructions #2922

Local-build-instructions #2922

arronlacey commented Dec 23, 2022 •

edited

netlify bot commented Dec 23, 2022 •

edited

sgibson91 left a comment

sgibson91 Jan 4, 2023

sandygudie Mar 2, 2023 •

edited

sgibson91 Mar 2, 2023

sandygudie Mar 2, 2023

sgibson91 Mar 2, 2023

arronlacey Mar 9, 2023

sgibson91 Mar 9, 2023

arronlacey Mar 9, 2023

arronlacey Mar 9, 2023

aleesteele commented Feb 22, 2023

RealRichi3 commented Feb 22, 2023

RealRichi3 commented Feb 23, 2023 •

edited

RealRichi3 commented Feb 23, 2023 •

edited

sgibson91 commented Feb 23, 2023 •

edited

RealRichi3 commented Feb 23, 2023

RealRichi3 commented Feb 23, 2023

samkitk commented Feb 26, 2023

sandygudie left a comment

aleesteele left a comment

sgibson91 left a comment

arronlacey commented Mar 10, 2023

Local-build-instructions #2922

Local-build-instructions #2922

Conversation

arronlacey commented Dec 23, 2022 • edited

Summary

List of changes proposed in this PR (pull-request)

What should a reviewer concentrate their feedback on?

Acknowledging contributors

netlify bot commented Dec 23, 2022 • edited

✅ Deploy Preview for the-turing-way ready!

sgibson91 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sandygudie Mar 2, 2023 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

aleesteele commented Feb 22, 2023

RealRichi3 commented Feb 22, 2023

RealRichi3 commented Feb 23, 2023 • edited

RealRichi3 commented Feb 23, 2023 • edited

sgibson91 commented Feb 23, 2023 • edited

RealRichi3 commented Feb 23, 2023

RealRichi3 commented Feb 23, 2023

samkitk commented Feb 26, 2023

sandygudie left a comment

Choose a reason for hiding this comment

aleesteele left a comment

Choose a reason for hiding this comment

sgibson91 left a comment

Choose a reason for hiding this comment

arronlacey commented Mar 10, 2023

arronlacey commented Dec 23, 2022 •

edited

netlify bot commented Dec 23, 2022 •

edited

sandygudie Mar 2, 2023 •

edited

RealRichi3 commented Feb 23, 2023 •

edited

RealRichi3 commented Feb 23, 2023 •

edited

sgibson91 commented Feb 23, 2023 •

edited