Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions astro.config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -127,6 +127,13 @@ export default defineConfig({
}
]
},
{
label: 'Demos',
translations: {
'zh-Hant': '演示範例'
},
autogenerate: { directory: 'demos' }
},
...openAPISidebarGroups
],
customCss: ['./src/styles/global.css'],
Expand Down
70 changes: 70 additions & 0 deletions src/content/docs/demos/01-coder.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
---
title: Coder Demo
description: Deploy Coder for cloud-based VS Code IDE environments with support for both Go and Python backends.
---

import { Steps, Aside, LinkCard } from '@astrojs/starlight/components';

This guide demonstrates how to deploy Coder to provide cloud-based VS Code IDE environments for development and coding.

## Deploy Coder

<Aside type="tip">
Coder provides a cloud-based VS Code IDE that can be accessed through a web browser. It supports multiple backend options including Go and Python versions, making it suitable for various development workflows.
</Aside>

<Steps>

1. Navigate to the Applications Store:

Open your browser and go to:
```
<url>/scope/<scope-name>/applications/store
```

2. Search and install Coder:

- Search for `code-server` (available versions: `code-server-go` or `code-server-python`)
- Choose your preferred version (Go for better performance, Python for flexibility)
- Click on the Coder card
- Click the **Install** button and follow the installation wizard
- Review and confirm the Helm Chart configuration

3. Verify the deployment:

Go to the Workloads page:
```
<url>/scope/<scope-name>/applications/workloads
```

- Use the **Namespace** filter to find the deployment
- Search for `coder` or `code-server` to locate the deployed Coder workload
- Verify that the workload status shows as running

4. Access Coder VS Code IDE:

- In the Workloads list, locate the Coder workload
- Click on the **NodePort** link to open VS Code in your browser

<Aside type="tip" title="Default Credentials">
Access the VS Code IDE directly through the NodePort link. Once opened, you can start coding immediately. Authentication and access control are managed through the application deployment settings.
</Aside>

</Steps>

## Initial Setup

Once Coder is deployed and running:

1. Access the VS Code IDE through the NodePort link in your browser
2. You'll see the VS Code interface with a file explorer and terminal
3. Start creating or editing files directly in the browser-based editor
4. Use the integrated terminal for running commands and development tasks

## Next Steps

Explore other demo applications to enhance your infrastructure:

<LinkCard title="PostgreSQL Demo" href="/demos/03-postgres/" description="Learn how to deploy PostgreSQL database and test read/write operations with Python." />

<LinkCard title="LLM Model Demo" href="/demos/04-llm-model/" description="Learn how to deploy and configure language model applications." />
Comment on lines +68 to +70

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

For consistency and better navigation between the new demo guides, I recommend adding a link to the JupyterHub demo. It's also a good practice to keep these links in a consistent order (e.g., numerical).

<LinkCard title="JupyterHub Demo" href="/demos/02-jupyterhub/" description="Deploy JupyterHub for multi-user Jupyter notebook environments." />

<LinkCard title="PostgreSQL Demo" href="/demos/03-postgres/" description="Learn how to deploy PostgreSQL database and test read/write operations with Python." />

<LinkCard title="LLM Model Demo" href="/demos/04-llm-model/" description="Learn how to deploy and configure language model applications." />

73 changes: 73 additions & 0 deletions src/content/docs/demos/02-jupyterhub.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
---
title: JupyterHub Demo
description: Deploy JupyterHub for multi-user Jupyter notebook environments.
---

import { Steps, Aside, LinkCard } from '@astrojs/starlight/components';

This guide demonstrates how to deploy JupyterHub to provide collaborative Jupyter notebook environments for multiple users.

## Deploy JupyterHub

<Aside type="tip">
JupyterHub provides a multi-user environment where multiple users can access Jupyter notebooks simultaneously, making it ideal for collaborative data science and educational purposes.
</Aside>

<Steps>

1. Navigate to the Applications Store:

Open your browser and go to:
```
<url>/scope/<scope-name>/applications/store
```

2. Search and install JupyterHub:

- Search for `jupyterhub`
- Click on the JupyterHub card
- Click the **Install** button and follow the installation wizard
- Review and confirm the Helm Chart configuration

3. Verify the deployment:

Go to the Workloads page:
```
<url>/scope/<scope-name>/applications/workloads
```

- Use the **Namespace** filter to find the deployment
- Search for `jupyterhub` to locate the deployed JupyterHub workload
- Verify that the workload status shows as running

4. Access JupyterHub:

- In the same Workloads list, locate the workload named **proxy**
- Click on the **NodePort** link to open JupyterHub in your browser

<Aside type="tip" title="Default Credentials">
The default login credentials are:
- **Username**: `admin`
- **Password**: `admin`

For production environments, it's highly recommended to change these credentials through JupyterHub administration settings.
</Aside>

</Steps>

## Initial Setup

Once JupyterHub is deployed and running:

1. Access the JupyterHub login page
2. Create or log in with your credentials
3. Start a new notebook server
4. Begin using Jupyter notebooks for data analysis and development

## Next Steps

Explore other demo applications to enhance your infrastructure:

<LinkCard title="PostgreSQL Demo" href="/demos/03-postgres/" description="Learn how to deploy PostgreSQL database and test read/write operations with Python." />

<LinkCard title="LLM Model Demo" href="/demos/04-llm-model/" description="Learn how to deploy and configure language model applications." />
Comment on lines +71 to +73

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

To improve navigation and maintain consistency across the demo guides, please add a link to the Coder demo in this 'Next Steps' section. Ordering the links numerically would also improve user experience.

<LinkCard title="Coder Demo" href="/demos/01-coder/" description="Deploy Coder for cloud-based VS Code IDE environments with support for both Go and Python backends." />

<LinkCard title="PostgreSQL Demo" href="/demos/03-postgres/" description="Learn how to deploy PostgreSQL database and test read/write operations with Python." />

<LinkCard title="LLM Model Demo" href="/demos/04-llm-model/" description="Learn how to deploy and configure language model applications." />

Loading
Loading