Skip to content

Commit d103820

Browse files
authored
Add documentation about dynamic image building and minor rearrangement (#268)
1 parent 356e724 commit d103820

4 files changed

Lines changed: 30 additions & 22 deletions

File tree

admin/billing/index.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Billing and cloud costs
2+
3+
Information about monitoring and controlling the cloud costs for your hub, as well as setting up your own cloud accounts to power your infrastructure.
4+
5+
```{toctree}
6+
:maxdepth: 2
7+
../howto/create-billing-account
8+
../../topic/cloud-costs
9+
../../topic/budget-alerts
10+
```

index.md

Lines changed: 9 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -24,16 +24,16 @@ They are meant for individuals who wish to learn about the service for their own
2424
about/service/options
2525
about/service/index
2626
user/topics/policy/index
27-
See a table of our running hubs! <https://infrastructure.2i2c.org/reference/hubs/>
27+
☁️ Table of running hubs <https://infrastructure.2i2c.org/reference/hubs/>
2828
```
2929

30-
## Use the hub
30+
## Hub users
3131

3232
Covers end-user workflows that are common for cloud-native workflows with interactive computing.
3333

3434
```{toctree}
3535
:maxdepth: 2
36-
:caption: Use the hub
36+
:caption: Hub users
3737
3838
user/topics/getting-started
3939
user/topics/data/index
@@ -42,14 +42,14 @@ community/content
4242
user/howto/launch-dask-gateway-cluster
4343
```
4444

45-
## Administer the hub
45+
## Hub administrators
4646

4747
Information for those with the **hub administrator** role on a JupyterHub.
4848
These cover many things that you can do to manage and configure your hub and its infrastructure.
4949

5050
```{toctree}
5151
:maxdepth: 2
52-
:caption: Administer the hub
52+
:caption: Hub administrators
5353
5454
support
5555
admin/howto/configurator
@@ -61,32 +61,19 @@ admin/topics/network
6161
admin/topics/managing-secrets
6262
```
6363

64-
## Community leadership
64+
## Community leaders
6565

6666
Covers topics relevant to those that are leading others in a community.
6767

6868
```{toctree}
69-
:caption: Community leadership
69+
:caption: Community leaders
7070
:maxdepth: 2
7171
72+
admin/howto/new-hub
73+
admin/billing/index
7274
community/events
7375
community/strategy
74-
```
75-
76-
## Community representatives
77-
78-
Documentation for those serving as _Community Representatives_.
79-
These tend to cover technical, administrative, invoicing, and collaborative processes for interacting with 2i2c's team on behalf of your community.
80-
81-
```{toctree}
82-
:caption: Community representatives
83-
:maxdepth: 2
84-
85-
admin/howto/new-hub
8676
admin/howto/replicate
87-
admin/howto/create-billing-account
88-
topic/cloud-costs
89-
topic/budget-alerts
9077
```
9178

9279
## Reference material

noxfile.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
import nox
22

3+
nox.options.default_venv_backend = "uv"
34
nox.options.reuse_existing_virtualenvs = True
45

56
build_command = ["-b", "dirhtml", ".", "_build/dirhtml"]

user/environment/dynamic-imagebuilding.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,16 @@ Environment images are cached automatically, so if you give another hub user the
9393

9494
Just update any of the files in your environment repository, and your environment will be re-built the next time you launch a session from it.
9595

96+
### Why don't I see the files in my repository when I launch an environment?
97+
98+
Dynamic environment image generation is **only for the software environment**, it does not include any content files in the environment that is created.
99+
100+
:::{seealso}
101+
See [](#content:nbgitpuller) for ways to share content along with repositories.
102+
:::
103+
104+
This is an important difference from [mybinder.org](https://mybinder.org). While Binder is designed for reproducibility, dynamic image generation is designed for users to quickly define software environments for their hubs. For this reason, Binder packages as much as it can in a single link (software, content, etc), while dynamic image building only includes the software environment.
105+
96106
### Can I use another community's pre-existing environment?
97107

98108
Yes! That's often the simplest choice. See [this repo2docker guide on choosing an environment](https://repo2docker.readthedocs.io/en/latest/use/pathways/) for guidance.

0 commit comments

Comments
 (0)