Skip to content

Commit

Permalink
Break reference into individual pages
Browse files Browse the repository at this point in the history
  • Loading branch information
craddm committed Nov 27, 2024
1 parent 9f0b6a6 commit 4792c11
Show file tree
Hide file tree
Showing 7 changed files with 85 additions and 58 deletions.
10 changes: 10 additions & 0 deletions docs/source/reference/config.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# `config`

`dsh config` commands are used to manage the configuration files that define SHMs and SREs.

:::{typer} data_safe_haven.commands.config:config_command_group
:width: 65
:prog: dsh config
:show-nested:
:make-sections:
:::
10 changes: 10 additions & 0 deletions docs/source/reference/context.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# `context`

`dsh context` commands are used to manage the Data Safe Haven contexts, which are the grouping within which a single SHM and its associated SREs are organised.

:::{typer} data_safe_haven.commands.context:context_command_group
:width: 65
:prog: dsh context
:show-nested:
:make-sections:
:::
85 changes: 27 additions & 58 deletions docs/source/reference/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,18 @@
# Reference

## `dsh` command line interface
:::{toctree}
:hidden:

config.md
context.md
users.md
pulumi.md
shm.md
sre.md
:::

A Data Safe Haven is managed using the `dsh` command line interface.
A full guide to the commands available for managing your Data Safe Haven is provided here.

The `dsh` commands are the entrypoint to the Data Safe Haven command line interface.
All commands begin with `dsh`.
Expand All @@ -10,66 +22,23 @@ All commands begin with `dsh`.
:width: 65
:::

## `config` commands

`config` commands are used to manage the configuration files that define SHMs and SREs.

:::{typer} data_safe_haven.commands.config:config_command_group
:width: 65
:prog: dsh config
:show-nested:
:make-sections:
:::

## `context` commands

`context` commands are used to manage the Data Safe Haven contexts, which are the grouping within which a single SHM and its associated SREs are organised.

:::{typer} data_safe_haven.commands.context:context_command_group
:width: 65
:prog: dsh context
:show-nested:
:make-sections:
:::

## `shm` commands
The subcommands can be used to manage various aspects of a Data Safe Haven deployment.
For further detail on each subcommand, navigate to the relevant page.

`shm` commands are used to deploy or teardown DSH Safe Haven Management infrastructure
[Config](config.md)
: Management of the configuration files used to define SHMs and SREs

:::{typer} data_safe_haven.commands.shm:shm_command_group
:width: 65
:prog: dsh shm
:show-nested:
:make-sections:
:::

## `sre` commands

`sre` commands are used to deploy or teardown the infrastructure for DSH Secure Research Environments

:::{typer} data_safe_haven.commands.sre:sre_command_group
:width: 65
:prog: dsh sre
:show-nested:
:make-sections:
:::

## `users` commands
[Context](context.md)
: Manage DSH contexts, the groupings that encompass an SHM and its associated SREs

`users` commands are used to manage users on the Entra ID associated with a DSH deployment.
[Users](users.md)
: Management of users in Entra ID

:::{typer} data_safe_haven.commands.users:users_command_group
:width: 65
:prog: dsh users
:show-nested:
:make-sections:
:::
[Pulumi](pulumi.md)
: An interface to the Pulumi command line interface

## `pulumi` commands
[shm](shm.md)
: Management of infrastructure for DSH Safe Haven Management environments

:::{typer} data_safe_haven.commands.pulumi:pulumi_command_group
:width: 65
:prog: dsh pulumi
:show-nested:
:make-sections:
:::
[sre](sre.md)
: Management of infrastructure for DSH Secure Research Environments
8 changes: 8 additions & 0 deletions docs/source/reference/pulumi.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# `pulumi`

:::{typer} data_safe_haven.commands.pulumi:pulumi_command_group
:width: 65
:prog: dsh pulumi
:show-nested:
:make-sections:
:::
10 changes: 10 additions & 0 deletions docs/source/reference/shm.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# `shm`

`dsh shm` commands are used to deploy or teardown DSH Safe Haven Management infrastructure

:::{typer} data_safe_haven.commands.shm:shm_command_group
:width: 65
:prog: dsh shm
:show-nested:
:make-sections:
:::
10 changes: 10 additions & 0 deletions docs/source/reference/sre.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# `sre`

`dsh sre` commands are used to deploy or teardown the infrastructure for DSH Secure Research Environments

:::{typer} data_safe_haven.commands.sre:sre_command_group
:width: 65
:prog: dsh sre
:show-nested:
:make-sections:
:::
10 changes: 10 additions & 0 deletions docs/source/reference/users.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# `users`

`dsh users` commands are used to manage users on the Entra ID associated with a DSH deployment.

:::{typer} data_safe_haven.commands.users:users_command_group
:width: 65
:prog: dsh users
:show-nested:
:make-sections:
:::

0 comments on commit 4792c11

Please sign in to comment.