-
Notifications
You must be signed in to change notification settings - Fork 151
/
Copy pathmkdocs.yml
165 lines (150 loc) · 8.56 KB
/
mkdocs.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
---
site_name: Azure TRE
site_url: https://github.com/microsoft/AzureTRE
site_description: Azure TRE
site_author: Microsoft
repo_url: https://github.com/microsoft/AzureTre/
edit_uri: ""
theme:
name: material
custom_dir: mkdocs-overrides
font:
text: Roboto
code: Roboto Mono
palette:
scheme: default
primary: blue grey
accent: indigo
logo: assets/ms_icon.png
favicon: assets/ms_icon.png
features:
- navigation.instant
- navigation.indexes
plugins:
- search
markdown_extensions:
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- meta
- admonition
- pymdownx.highlight
- pymdownx.pathconverter
- mdx_truly_sane_lists
- pymdownx.tabbed
- pymdownx.tasklist
nav:
- Overview: # Pages to explain what the Azure TRE
- Introducing the AzureTRE: index.md # Introduction to the concept of a TRE, and the AzureTRE
- User Roles: azure-tre-overview/user-roles.md # The users and roles within an Azure TRE
- Architecture: # Pages to help understand the components, infra, and networking
- System Architecture: azure-tre-overview/architecture.md
- Network Architecture: azure-tre-overview/networking.md
- Azure Resources: azure-tre-overview/tre-resources-breakdown.md
- Airlock: azure-tre-overview/airlock.md
- Cost Reporting: azure-tre-overview/cost-reporting.md
- Terms and Definitions: using-tre/terms-definitions.md
# - Compliance: azure-tre-overview/compliance-info.md
- QuickStart: # Setup steps for anyone performing an initial deployment of the AzureTRE for eval purposes
- tre-admins/setup-instructions/index.md
- 1. Prerequisites: tre-admins/setup-instructions/prerequisites.md
- 2. Deployment Repository: tre-admins/setup-instructions/deployment-repo.md
- 3. AD Tenant: tre-admins/setup-instructions/ad-tenant-choices.md
- 4. Setup Auth: tre-admins/setup-instructions/setup-auth-entities.md
- 5. Deployment:
- Manual:
- Pre-deployment Steps: tre-admins/setup-instructions/manual-pre-deployment-steps.md
- Deployment Steps: tre-admins/setup-instructions/manual-deployment.md
- CI/CD:
- Pre-deployment Steps: tre-admins/setup-instructions/cicd-pre-deployment-steps.md
- Deployment Steps: tre-admins/setup-instructions/cicd-deplyment.md
- 6. Configure Shared Services: tre-admins/setup-instructions/configuring-shared-services.md
- 7. Install Base Workspace: tre-admins/setup-instructions/ui-install-base-workspace.md
- 8. Install Workspace Service and User Resource: tre-admins/setup-instructions/ui-install-ws-and-ur.md
- Using the Azure TRE: # Documentation for users of the TRE
- Introduction: using-tre/index.md
- Custom Templates: using-tre/templates/index.md
- Using AzureTRE for Research:
- Introduction: using-tre/tre-for-research/index.md
- Set up of a Virtual Machine: using-tre/tre-for-research/using-vms.md
- Importing/exporting data with Airlock: using-tre/tre-for-research/importing-exporting-data-airlock.md
- Reviewing Airlock Requests: using-tre/tre-for-research/review-airlock-request.md
# - Workspaces:
# - using-tre/wks/index.md # Documentation describing what a workspace is
# - Using Workspaces: using-tre/wks/using-wks.md # Interacting with workspaces (via the UI)
# - The Workspace Owner: using-tre/wks/wks-owner.md # Workspace Owners. The concept, and tasks
# - FAQ: using-tre/faq.md # FAQ section (to allow easy contribution)
- Templates and Services: # Docs to highlight and illustrate workspaces, workspace services etc
- Workspaces:
- Base: tre-templates/workspaces/base.md
- Unrestricted: tre-templates/workspaces/unrestricted.md
- Airlock Import Review: tre-templates/workspaces/airlock-import-review.md
- Workspace Services:
- Azure ML: tre-templates/workspace-services/azure-ml.md
- Gitea: tre-templates/workspace-services/gitea.md
- Guacamole: tre-templates/workspace-services/guacamole.md
- InnerEye: tre-templates/workspace-services/inner-eye.md
- MLFlow: tre-templates/workspace-services/mlflow.md
- Health Services: tre-templates/workspace-services/health_services.md
- Azure Databricks: tre-templates/workspace-services/databricks.md
- Shared Services:
- Gitea (Source Mirror): tre-templates/shared-services/gitea.md
- Nexus (Package Mirror): tre-templates/shared-services/nexus.md
- Azure CycleCloud (HPC Compute): tre-templates/shared-services/cyclecloud.md
- Airlock Notifier: tre-templates/shared-services/airlock-notifier.md
- User Resources:
- Guacamole Windows VM: tre-templates/user-resources/guacamole-windows-vm.md
- Guacamole Linux VM: tre-templates/user-resources/guacamole-linux-vm.md
- Import Review VM: tre-templates/user-resources/import-reviewvm.md
- Export Review VM: tre-templates/user-resources/export-reviewvm.md
- Technical Guide: # All Technical Documentation (Admin, Development)
- Administration: # Docs related to the deployment and operation of AzureTRE infrastructure
- Starting and Stopping Azure TRE Services: tre-admins/start-stop.md
- Environment Variables: tre-admins/environment-variables.md
- Tear-down: tre-admins/tear-down.md
- Authentication and Authorization:
- Introduction: tre-admins/auth.md
- Manual Setup: tre-admins/identities/auth-manual.md
- Identities:
- Application Admin: tre-admins/identities/application_admin.md
- API: tre-admins/identities/api.md
- Client: tre-admins/identities/client.md
- Automation Test Account: tre-admins/identities/test-account.md
- Workspaces: tre-admins/identities/workspace.md
- Registering Templates: tre-admins/registering-templates.md
- Install Resources via API:
- Install Base Workspace: tre-admins/setup-instructions/installing-base-workspace.md
# yamllint disable-line rule:line-length
- Install Workspace Service and User Resource: tre-admins/setup-instructions/installing-workspace-service-and-user-resource.md
- Upgrading AzureTRE Version: tre-admins/upgrading-tre.md
- Upgrading Resources Version: tre-admins/upgrading-resources.md
- Configuring Airlock Reviews: tre-admins/configure-airlock-review.md
- Development: # Docs related to the developing code for the AzureTRE
- Local Development: using-tre/local-development/local-development.md
- Contributing to AzureTRE: # Docs aimed at OSS developers, committing code to the AzureTRE repo
- Introduction: tre-developers/index.md
- API: tre-developers/api.md
- UI: tre-developers/ui.md
- Resource Processor: tre-developers/resource-processor.md
- End to End Tests: tre-developers/end-to-end-tests.md
- Letsencrypt: tre-developers/letsencrypt.md
- Releases: tre-developers/release.md
- GitHub Actions: tre-admins/setup-instructions/workflows.md
- Developing Workspace Templates: # Docs aimed at developers creating workspace templates
- Authoring Workspace Templates: tre-workspace-authors/authoring-workspace-templates.md
- Firewall Rules: tre-workspace-authors/firewall-rules.md
- Pipeline Templates:
- Overview: tre-templates/pipeline-templates/overview.md
- Pipeline Schema: tre-templates/pipeline-templates/pipeline-schema.md
- AzureTRE CLI: tre-developers/CLI.md
- Troubleshooting FAQ: # General Troubleshooting Section for Development
- troubleshooting-faq/index.md
- Enabling Debugging for the API: troubleshooting-faq/debug-api.md
- API logs using deployment center: troubleshooting-faq/api-logs-deployment-center.md
- Checking the Service Bus: troubleshooting-faq/troubleshooting-sb.md
- Checking Logs in Application Insights: troubleshooting-faq/app-insights-logs.md
- Troubleshooting the Resource Processor: troubleshooting-faq/troubleshooting-rp.md
- Manually edit resources in Cosmos DB: troubleshooting-faq/manually-editing-resources.md
- Contributing: contributing.md