Skip to content

Commit cb6e7bf

Browse files
authored
Merge pull request #5940 from ryanlovett/docs-misc
Use listing for hubs.
2 parents 7fcafaa + 2bf0a31 commit cb6e7bf

File tree

14 files changed

+138
-118
lines changed

14 files changed

+138
-118
lines changed

docs/_quarto.yml

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -59,10 +59,6 @@ website:
5959
- admins/howto/clusterswitch.qmd
6060
- admins/howto/github-token.qmd
6161
- admins/howto/google-sheets.qmd
62-
- section: "Hub Deployments"
63-
contents:
64-
- admins/deployments/datahub.qmd
65-
- admins/deployments/stat159.qmd
6662
- section: "Policy"
6763
contents:
6864
- policy/create_policy.qmd

docs/admins/deployments/datahub.qmd

Lines changed: 0 additions & 22 deletions
This file was deleted.

docs/admins/deployments/index.qmd

Lines changed: 0 additions & 3 deletions
This file was deleted.

docs/users/authentication.qmd

Lines changed: 11 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2,31 +2,28 @@
22
title: User Authentication
33
---
44

5-
UC Berkeley uses a [Canvas](https://www.instructure.com/canvas/) instance,
6-
called [bcourses.berkeley.edu](https://bcourses.berkeley.edu). Almost
7-
all our hubs use this for authentication, although [not all yet](https://github.com/berkeley-dsep-infra/datahub/issues/1574).
5+
Most of our hubs use a [Canvas](https://www.instructure.com/canvas/) instance,
6+
[bcourses.berkeley.edu](https://bcourses.berkeley.edu), for authentication. The hubs not using `CanvasOAuthenticator` are edx (`LTI1Authenticator`), highschool (`GoogleOAuthenticator`), and workshop (`dummy`).
87

9-
## Who has access?
8+
## Authorization
109

11-
Anyone who can log in to bcourses can log into our JupyterHubs. This
12-
includes all berkeley affiliates. If you have a working berkeley.edu
13-
email account, you can most likely log in to bcourses, and hence to
10+
Anyone who can log in to bCourses can log into our Canvas-based hubs. This
11+
includes all Berkeley affiliates. If you have a working berkeley.edu
12+
email account, you can most likely log in to bCourses, and hence to
1413
our JupyterHubs.
1514

1615
Students have access for 9 months after they graduate. If they have
1716
an incomplete, they have 13 months of access instead.
1817

19-
## Non-berkeley affiliates
18+
## Non-Berkeley affiliates
2019

2120
If someone who doesn't have a berkeley.edu account wants to use
22-
the JupyterHubs, they need to get a [CalNet Sponsored Guest
23-
account](https://calnetweb.berkeley.edu/calnet-departments/calnet-sponsored-guests)
24-
This gives people access to [bcourses](https://bcourses.berkeley.edu),
25-
and hence to all the JupyterHubs.
21+
the JupyterHubs, they need to obtain a [CalNet Sponsored Guest
22+
account](https://calnetweb.berkeley.edu/calnet-departments/calnet-sponsored-guests) and get added to a bCourses course.
2623

2724
## Troubleshooting
2825

29-
If you can log in to [bcourses](https://bcourses.berkeley.edu) but
26+
If you can log in to [bCourses](https://bcourses.berkeley.edu) but
3027
not to any of the JupyterHubs, please contact us.
3128

32-
If you can not log in to bcourses, please [contact bcourses support](https://dls.berkeley.edu/services/bcourses-0)
29+
If you can not log in to bCourses, please [contact bCourses support](https://dls.berkeley.edu/services/bcourses-0).

docs/users/hubs.qmd

Lines changed: 13 additions & 68 deletions
Original file line numberDiff line numberDiff line change
@@ -1,70 +1,15 @@
11
---
2-
title: JupyterHubs in this repository
2+
title: JupyterHub Deployments
3+
listing:
4+
categories: true
5+
contents:
6+
- "hubs/datahub.qmd"
7+
- "hubs/data100.qmd"
8+
- "hubs/data102.qmd"
9+
- "hubs/edx.qmd"
10+
- "hubs/prob140.qmd"
11+
- "hubs/r.qmd"
12+
- "hubs/shiny.qmd"
13+
- "hubs/stat159.qmd"
14+
- "hubs/stat20.qmd"
315
---
4-
5-
## DataHub
6-
7-
[datahub.berkeley.edu](https://datahub.berkeley.edu) is the \'main\'
8-
JupyterHub for use on UC Berkeley campus. It\'s the largest and most
9-
active hub. It has many Python & R packages installed.
10-
11-
It runs on [Google Cloud Platform](https://cloud.google.com) in the
12-
`ucb-datahub-2018` project. You can see all config for it under
13-
`deployments/datahub`.
14-
15-
### Classes
16-
17-
- The big [data8](http://data8.org/) class.
18-
- Active [connector
19-
courses](https://data.berkeley.edu/education/connectors)
20-
- [Data Science Modules](https://data.berkeley.edu/education/modules)
21-
- [Astro
22-
128/256](https://astro.berkeley.edu/course-information/3958209-astronomy-data-science-laboratory)
23-
24-
This hub is also the \'default\' when folks wanna use a hub for a short
25-
period of time for any reason without super specific requirements.
26-
27-
## Prob140 Hub
28-
29-
A hub specifically for [prob140](http://prob140.org/). Some of the admin
30-
users on `hubs/datahub`{.interpreted-text role="ref"} are students in
31-
prob140 - this would allow them to see the work of other prob140
32-
students. Hence, this hub is separate until JupyterHub gains features
33-
around restricting admin use.
34-
35-
It runs on [Google Cloud Platform](https://cloud.google.com) in the
36-
`ucb-datahub-2018` project. You can see all config for it under
37-
`deployments/prob140`.
38-
39-
## Data 100
40-
41-
This hub is for [Data 100](http://www.ds100.org/) which has a unique
42-
user and grading environment. It runs on [Google Cloud
43-
Platform](https://cloud.google.com) in the `ucb-datahub-2018` account.
44-
You can see all config for it under `deployments/data100`.
45-
46-
Data100 also has shared folders between staff (professors and GSIs) and
47-
students. Staff, assuming they have been added as admins in
48-
`config/common.yaml`, can see a `shared` and a `shared-readwrite`
49-
folder. Students can only see the `shared` folder, which is read-only.
50-
Anything that gets put in `shared-readwrite` is automatically viewable
51-
in `shared`, but as read-only files. The purpose of this is to be able
52-
to share large data files instead of having one per student.
53-
54-
## Data 102
55-
56-
Data 102 runs on [Google Cloud Platform](https://cloud.google.com) in the
57-
`ucb-datahub-2018` project. You can see all config for it under
58-
`deployments/data102`.
59-
60-
## Data8X Hub
61-
62-
A hub for the [data8x course on
63-
EdX](https://www.edx.org/professional-certificate/berkeleyx-foundations-of-data-science).
64-
This hub is open to use by anyone in the world, using [LTI
65-
Authentication](https://github.com/jupyterhub/ltiauthenticator) to
66-
provide login capability from inside EdX.
67-
68-
It runs on [Google Cloud Platform](https://cloud.google.com) in the
69-
`data8x-scratch` project. You can see all config for it under
70-
`deployments/data8x`.

docs/users/hubs/data100.qmd

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
title: Data 100
3+
categories:
4+
- jupyterlab
5+
- otter-grader
6+
- shared-folders
7+
---
8+
9+
This hub is for [Data 100](http://www.ds100.org/) which has a unique
10+
user and grading environment.
11+
12+
Data100 has shared folders between staff (professors and GSIs) and
13+
students. Course staff can see a `shared` and a `shared-readwrite`
14+
folder. Students can only see the `shared` folder, which is read-only.
15+
Anything that gets put in `shared-readwrite` is automatically viewable
16+
in `shared`, but as read-only files. The purpose of this is to be able
17+
to share large data files instead of having one per student.

docs/users/hubs/data102.qmd

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
title: Data 102
3+
categories:
4+
- jupyterlab
5+
- otter-grader
6+
- shared-folders
7+
---
8+
9+
This hub is for [Data 102](http://www.ds102.org/) which has a unique
10+
user and grading environment.
11+
12+
Data 102 runs on [Google Cloud Platform](https://cloud.google.com) in the
13+
`ucb-datahub-2018` project. You can see all config for it under
14+
`deployments/data102`.

docs/users/hubs/datahub.qmd

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
title: DataHub
3+
categories:
4+
- jupyterlab
5+
- r
6+
- vscode
7+
aliases:
8+
- ../admins/deployments/datahub.html
9+
---
10+
11+
[datahub.berkeley.edu](https://datahub.berkeley.edu) is the *main* JupyterHub
12+
for use at UC Berkeley. It is the largest and most active hub, and provides a
13+
standard computing environment to many foundational courses across diverse
14+
disciplines.
15+
16+
## Image
17+
18+
The datahub image contains both Python and R environments. A user can
19+
create jupyter notebooks utilizing either Python or R, or can run
20+
RStudio using R or Python.

docs/users/hubs/edx.qmd

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
title: Data 8X
3+
categories:
4+
- jupyterlab
5+
- ltiauthenticator
6+
---
7+
8+
This hub is for the [data8x course on EdX](https://www.edx.org/professional-certificate/berkeleyx-foundations-of-data-science).
9+
It is open to use by anyone in the world, using [LTI
10+
Authentication](https://github.com/jupyterhub/ltiauthenticator) to
11+
provide login capability from inside EdX.
12+
13+
It runs on [Google Cloud Platform](https://cloud.google.com) in the
14+
`data8x-scratch` project. You can see all config for it under
15+
`deployments/data8x`.

docs/users/hubs/prob140.qmd

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
title: Prob 140
3+
categories:
4+
- jupyterlab
5+
- vscode
6+
---
7+
8+
Prob 140 hub exists to isolate student files from the main hub. Some students
9+
in this course might be course staff in another course, or vice versa, so we
10+
isolate their home directories through this hub. It uses the same singleuser
11+
docker image as the main hub.

0 commit comments

Comments
 (0)