Skip to content

Commit ab27dbb

Browse files
authored
feat(ui): add a progress bar in the onboarding doc (#587)
2 parents 4496606 + 41ade43 commit ab27dbb

File tree

5 files changed

+1706
-5
lines changed

5 files changed

+1706
-5
lines changed

docs/hackathon/0-onboarding.mdx

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ import useBaseUrl from "@docusaurus/useBaseUrl";
1212
import AccessGranted from "/static/img/verifiable-ai-hackathon/access-granted.png";
1313
import ChooseTemplate from "/static/img/verifiable-ai-hackathon/choose-template.png";
1414
import GeminiKey from "/static/img/verifiable-ai-hackathon/gemini-key.png";
15+
import OnboardingChecklist from "@site/src/components/hackathon/OnboardingChecklist";
1516
import CreateKey from "/static/img/verifiable-ai-hackathon/create-key.png";
1617

1718
# Onboarding
@@ -20,6 +21,8 @@ Welcome to the **Verifiable AI Hackathon**! 🎉
2021

2122
This guide walks you through the **four-step setup** to ensure you have the necessary access and tools to start building.
2223

24+
<OnboardingChecklist />
25+
2326
## Before You Begin
2427

2528
- **Estimated Time:** ~15-20 minutes

docs/hackathon/1-cookbook.mdx

Lines changed: 23 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,26 @@ description: Cookbook commands for managing Confidential VMs.
66
keywords: [flare, ai, confidential-compute, hackathon, google-cloud, onboarding]
77
---
88

9+
import ConfidentialVMBuilder from "@site/src/components/ConfidentialVMBuilder";
10+
911
Reference for commands you will encounter when interacting with Confidential VMs.
1012

13+
## Confidential Space command builder
14+
15+
Use this interactive builder to generate the exact Confidential Space VM deploy command you need.
16+
17+
:::warning[Source your .env file]
18+
19+
Before running the following gcloud command don't forget to source your `.env` file:
20+
21+
```bash
22+
source .env
23+
```
24+
25+
:::
26+
27+
<ConfidentialVMBuilder />
28+
1129
## Restarting VMs
1230

1331
During testing, you often need to restart a VM to pull updated docker images.
@@ -46,9 +64,9 @@ You can also view logs in the Google Cloud Console by navigating to the Logging
4664

4765
:::
4866

49-
## Deploying AMD SEV Confidential VMs
67+
## Deploying on AMD SEV
5068

51-
This command creates a Confidential Computing VM instance using AMD SEV ([Secure Encrypted Virtualization](https://www.amd.com/content/dam/amd/en/documents/epyc-business-docs/white-papers/memory-encryption-white-paper.pdf)), with a specific image, network configuration, and security settings.
69+
This command creates a Confidential Space VM instance using AMD SEV ([Secure Encrypted Virtualization](https://www.amd.com/content/dam/amd/en/documents/epyc-business-docs/white-papers/memory-encryption-white-paper.pdf)), with a specific image, network configuration, and security settings.
5270
The metadata section is critical for configuring the Trusted Execution Environment (TEE).
5371
The command is broken down in the following sections.
5472

@@ -188,10 +206,10 @@ gcloud compute instances create $INSTANCE_NAME \
188206
- `--reservation-affinity=any`: If you have reservations, this allows the VM to use any available reservation.
189207
- `--confidential-compute-type=SEV`: Enables AMD SEV (Secure Encrypted Virtualization) Confidential Computing. This is the core flag that makes this instance a confidential VM.
190208

191-
## Deploying Intel TDX Confidential VMs
209+
## Deploying on Intel TDX
192210

193-
This command creates a Confidential Computing VM instance using Intel TDX ([Trust Domain Extensions](https://www.intel.com/content/www/us/en/developer/tools/trust-domain-extensions/documentation.html)), with a specific image, network configuration, and security settings.
194-
The command instructions differing from [Deploying AMD SEV Confidential VMs](#deploying-amd-sev-confidential-vms) are highlighted.
211+
This command creates a Confidential Space VM instance using Intel TDX ([Trust Domain Extensions](https://www.intel.com/content/www/us/en/developer/tools/trust-domain-extensions/documentation.html)), with a specific image, network configuration, and security settings.
212+
The command instructions differing from [Deploying AMD SEV Confidential VMs](#deploying-on-amd-sev) are highlighted.
195213

196214
```bash
197215
gcloud compute instances create $INSTANCE_NAME \

0 commit comments

Comments
 (0)