Skip to content

Commit

Permalink
30: Update tutorials and their metadata (#35)
Browse files Browse the repository at this point in the history
* Rewrite beginnings of in the cloud tutorial

* Emphasise importance of hash in README

* Expand roles in README

* Write configuration section of cloud tutorial

* Finish in the cloud tutorial

* Update app screenshot

* Clean up app text

* Reduce verbosity in README

* Fix formatting in cloud tutorial

* Remove old set up tutorials

* Update metadata for cloud and FEBRL tutorials

* Remove old working in the cloud tutorial

* Add diagram to cloud tutorial; rename screenshot

* Remove numbering for tutorials; improve index UI

* Add sidebar for tutorials

* Add link to cloud tutorial in README

* Add bucket name clarification

Co-authored-by: Mat Weldon <[email protected]>

* Add explainer on other party resources

* Add gcloud instruction for adding roles

---------

Co-authored-by: Mat Weldon <[email protected]>
  • Loading branch information
daffidwilde and matweldon authored Apr 3, 2024
1 parent 845d6fb commit df00add
Show file tree
Hide file tree
Showing 15 changed files with 349 additions and 555 deletions.
10 changes: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -175,8 +175,14 @@ data owning-parties, or ask a trusted third party to maintain the
workload.

> [!WARNING]
> The cloud demo requires you to set up one or more Google Cloud accounts with billing. The cost of running the demo should be very small, or within your free quota.
> However, you should ensure that all resources are torn down after running the demo to avoid ongoing charges.
> The cloud demo requires you to set up one or more Google Cloud accounts with
> billing. The cost of running the demo should be very small, or within your
> free quota. However, you should ensure that all resources are torn down after
> running the demo to avoid ongoing charges.
Please refer to our
[cloud tutorial](https://datasciencecampus.github.io/pprl_toolkit/docs/tutorials/in-the-cloud)
for further details on how to get working in the cloud.

## Building the documentation

Expand Down
12 changes: 11 additions & 1 deletion _quarto.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,14 @@ website:
url: https://github.com/datasciencecampus/pprl
- text: Open an issue
url: https://github.com/datasciencecampus/pprl/issues
sidebar:
style: docked
search: true
contents:
- text: About
href: index.qmd
- auto: "*.qmd"
reader-mode: true
page-footer:
left: >
All content is available under the
Expand All @@ -29,7 +37,9 @@ website:
format:
html:
mainfont: Arial
theme: solar
theme:
light: flatly
dark: darkly
lang: en-GB

metadata-files:
Expand Down
Binary file added docs/_static/app-home-screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
110 changes: 0 additions & 110 deletions docs/tutorials/00-getting-started.qmd

This file was deleted.

115 changes: 0 additions & 115 deletions docs/tutorials/01-setup-server.qmd

This file was deleted.

123 changes: 0 additions & 123 deletions docs/tutorials/02-client.qmd

This file was deleted.

Loading

0 comments on commit df00add

Please sign in to comment.