Skip to content

Commit d2201ff

Browse files
committed
fix(docs): remove and enhance the content in VM Setup guide
1 parent e2853df commit d2201ff

File tree

3 files changed

+63
-145
lines changed

3 files changed

+63
-145
lines changed

docs/hackathon/1-VM-Setup.mdx

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

docs/hackathon/1-vm-setup.mdx

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
---
2+
sidebar_position: 2
3+
unlisted: true
4+
title: Setting up a VM
5+
description: Step-by-step guide for setting up a VM for the Verifiable AI Hackathon.
6+
keywords: [flare, ai, confidential-compute, hackathon, google-cloud, onboarding]
7+
---
8+
9+
# Setting up a VM
10+
11+
Follow these steps to set up and configure your Google Cloud VM instance.
12+
13+
## Prerequisites
14+
15+
1. **Install the gcloud CLI**
16+
17+
Follow the [gcloud CLI installation guide](https://cloud.google.com/sdk/docs/install) steps for your OS.
18+
19+
:::note[Common Installation Issues]
20+
If you encounter `gcloud: command not found` after installation:
21+
22+
1. Source your profile:
23+
24+
```bash
25+
source ~/.bashrc # For Linux/WSL
26+
source ~/.zshrc # For macOS
27+
```
28+
29+
2. If the issue persists, add gcloud to your PATH:
30+
31+
```bash
32+
export PATH="$HOME/google-cloud-sdk/bin:$PATH"
33+
```
34+
35+
3. Add the above line to your shell profile (~/.bashrc, ~/.zshrc, or ~/.bash_profile) for permanent effect
36+
:::
37+
38+
Verify installation:
39+
40+
```bash
41+
gcloud version
42+
```
43+
44+
2. **Authenticate your CLI**
45+
46+
:::warning[Important]
47+
Make sure to use the same Google account email that you submitted in the hackathon registration form. Using a different account will result in permission errors.
48+
:::
49+
50+
```bash
51+
gcloud auth login
52+
```
53+
54+
Verify project access:
55+
56+
```bash
57+
gcloud projects list # Should show verifiable-ai-hackathon
58+
```
59+
60+
## VM Setup and Deployment
61+
62+
For VM creation and deployment, please follow the README instructions in your respective [track's template](onboarding#choose-your-template) repository. Each track has detailed steps and commands for setting up the environment correctly.

sidebars.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ const sidebars: SidebarsConfig = {
2121
type: "doc",
2222
id: "hackathon/onboarding",
2323
},
24-
items: ["hackathon/onboarding", "hackathon/VM-Setup"],
24+
items: ["hackathon/onboarding", "hackathon/vm-setup"],
2525
},
2626
{
2727
type: "category",

0 commit comments

Comments
 (0)