alan-turing-institute / bio-Turing-Way

Experimenting with JupyterBooks, Sphinx, and training materials for biomed/life sciences from the Turing Way.
https://the-turing-way-personas.netlify.app/welcome
Other
4 stars 5 forks source link

The Turing Way Editions #19

Open myyong opened 2 years ago

myyong commented 2 years ago
  1. First prototype for "The Turing Way - Editions" found here:

To achieve this the user has to configure profile.yaml. An example for two editions dsg and enrichmentcan be configured the following way:

dsg:
  - welcome
  - communication/communication
  - communication/comms-overview
  - communication/comms-overview/comms-overview-principles
enrichment:
  - welcome
  - reproducible-research/reproducible-research
  - reproducible-research/overview
  - reproducible-research/overview/overview-definitions

In order to create a new group-leaderedition, the user adds to profile.yaml as follows, by including all pages relevant to that edition.

dsg:
  - welcome
  - communication/communication
  - communication/comms-overview
  - communication/comms-overview/comms-overview-principles
enrichment:
  - welcome
  - reproducible-research/reproducible-research
  - reproducible-research/overview
group-leader:
  - welcome
  - project-design/project-design
  - project-design/pd-overview
  - project-design/pd-overview/pd-overview-planning
  - project-design/pd-overview/pd-overview-repro
  - project-design/pd-overview/pd-overview-method
  - project-design/pd-overview/pd-overview-version
  1. Use the cards as shown in the image to navigate between the editions:
Screenshot 2021-11-30 at 13 58 03

Next step: We are currently working on fixing the hyperlinks within the cards. The current deployed version navigates to the correct edition, but does not link to any specific section.

myyong commented 2 years ago

We are currently at https://the-turing-way-choose-your-own-adventure.netlify.app/welcome.html. I think we may have issues with long build times.

A large build ends like this:

5:09:35 PM: ─────────────────────────────────────────────────────────
5:09:35 PM:   Netlify Build Complete                                        
5:09:35 PM: ─────────────────────────────────────────────────────────
5:09:35 PM: ​
5:09:35 PM: (Netlify Build completed in 18m 30s)
5:09:36 PM: Execution timed out after 20m15.085720459s
5:09:36 PM: Error running command: Command did not finish within the time limit
5:09:36 PM: Creating deploy upload records
5:09:36 PM: Failing build: Failed to build site
5:09:36 PM: Failed during stage 'building site': Command did not finish within the time limit
5:09:36 PM: Finished processing build request in 20m30.227444238s
5:09:40 PM: Starting post processing
5:09:40 PM: Post processing - HTML
5:10:05 PM: Post processing - header rules
5:10:05 PM: Post processing - redirect rules
5:10:05 PM: Post processing done
5:10:05 PM: Site is live ✨

Whereas a small build ends like this:

11:06:27 AM: ─────────────────────────────────────────────────────────
11:06:27 AM:   Netlify Build Complete                                        
11:06:27 AM: ─────────────────────────────────────────────────────────
11:06:27 AM: ​
11:06:27 AM: (Netlify Build completed in 4m 33.4s)
11:06:27 AM: Caching artifacts
11:06:27 AM: Started saving build plugins
11:06:27 AM: Finished saving build plugins
11:06:27 AM: Started saving pip cache
11:06:28 AM: Finished saving pip cache
11:06:28 AM: Started saving emacs cask dependencies
11:06:28 AM: Finished saving emacs cask dependencies
11:06:28 AM: Started saving maven dependencies
11:06:28 AM: Finished saving maven dependencies
11:06:28 AM: Started saving boot dependencies
11:06:28 AM: Finished saving boot dependencies
11:06:28 AM: Started saving rust rustup cache
11:06:28 AM: Finished saving rust rustup cache
11:06:28 AM: Started saving go dependencies
11:06:28 AM: Finished saving go dependencies
11:06:28 AM: Starting post processing
11:06:28 AM: Post processing - HTML
11:06:30 AM: Build script success
11:06:33 AM: Post processing - header rules
11:06:33 AM: Post processing - redirect rules
11:06:33 AM: Post processing done
11:06:33 AM: Site is live ✨
11:06:54 AM: Finished processing build request in 6m26.011485129s

I don't see anything here that says what happens if Command did not finish within the time limit.

myyong commented 2 years ago

So it looks like we have a build cutout time of 15 mins. We need about 7 minutes per book/pathway. There is a thread here

@malvikasharan are there any plans to get a Pro account for the-turing-way?

malvikasharan commented 2 years ago

hi @myyong, We have an open source account (allows multiple team members and pro features). When exceeding build minutes, we automatically purchase extra minutes: https://www.netlify.com/legal/open-source-policy. Some of the conversations we are having (on different repos) are around time limit, which I don’t see in the pro plan: https://www.netlify.com/pricing/#teams, can you please share with me what feature is missing that is a blocker for the current prototype? Can you make this repo public so that we can discuss this with Kirstie and Arielle who are the managing our budget for The Turing Way? (I have meanwhile posted it on Slack for them to be aware) image