Repository navigation
feat: Add new documentation pages for basic concepts, service managem… #14
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -36,12 +36,20 @@ export default defineConfig({ | |||||||||||||||||||||||||||||||||
| }, | ||||||||||||||||||||||||||||||||||
| sidebar: [ | ||||||||||||||||||||||||||||||||||
| { | ||||||||||||||||||||||||||||||||||
| label: 'Guides', | ||||||||||||||||||||||||||||||||||
| items: [{ label: 'Getting Started', slug: 'guides/example' }] | ||||||||||||||||||||||||||||||||||
| label: 'Get Started', | ||||||||||||||||||||||||||||||||||
| slug: 'get-started' | ||||||||||||||||||||||||||||||||||
| }, | ||||||||||||||||||||||||||||||||||
| { | ||||||||||||||||||||||||||||||||||
| label: 'Reference', | ||||||||||||||||||||||||||||||||||
| autogenerate: { directory: 'reference' } | ||||||||||||||||||||||||||||||||||
| label: 'Scope', | ||||||||||||||||||||||||||||||||||
| slug: 'scope' | ||||||||||||||||||||||||||||||||||
| }, | ||||||||||||||||||||||||||||||||||
| { | ||||||||||||||||||||||||||||||||||
| label: '基礎', | ||||||||||||||||||||||||||||||||||
| autogenerate: { directory: 'basic' } | ||||||||||||||||||||||||||||||||||
| }, | ||||||||||||||||||||||||||||||||||
| { | ||||||||||||||||||||||||||||||||||
| label: '服務', | ||||||||||||||||||||||||||||||||||
| autogenerate: { directory: 'service' } | ||||||||||||||||||||||||||||||||||
| }, | ||||||||||||||||||||||||||||||||||
|
Comment on lines
+46
to
53
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The sidebar labels '基礎' and '服務' are in Traditional Chinese, but they are in the root configuration which applies to all locales, including the default English locale. For better internationalization and consistency, these labels should be in English in the root configuration. You can then provide translations in the
Suggested change
|
||||||||||||||||||||||||||||||||||
| ...openAPISidebarGroups | ||||||||||||||||||||||||||||||||||
| ], | ||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| --- | ||
| title: Configuration | ||
| description: Global configuration for OtterScale. | ||
| --- | ||
|
|
||
| The Configuration section handles global settings for your OtterScale deployment. | ||
|
|
||
| ## System Settings | ||
|
|
||
| Configure system-wide settings such as: | ||
| - **Timezone**: Set the system timezone. | ||
| - **Updates**: Manage system updates. | ||
| - **Logging**: Configure logging levels and destinations. | ||
|
|
||
| ## User Management | ||
|
|
||
| Manage users and permissions for the platform. |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| --- | ||
| title: Machines | ||
| description: Manage machines in OtterScale. | ||
| --- | ||
|
|
||
| The Machines section allows you to manage the physical and virtual machines in your infrastructure. | ||
|
|
||
| ## Overview | ||
|
|
||
| Here you can view the status of your machines, their resource usage, and perform management actions. | ||
|
|
||
| ## Adding a Machine | ||
|
|
||
| To add a new machine to your cluster: | ||
| 1. Go to the Machines page. | ||
| 2. Click "Add Machine". | ||
| 3. Follow the instructions to provision the machine. | ||
|
|
||
| ## Monitoring | ||
|
|
||
| You can monitor the health and performance of your machines directly from the dashboard. |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| --- | ||
| title: Networking | ||
| description: Manage networking in OtterScale. | ||
| --- | ||
|
|
||
| The Networking section allows you to configure the network settings for your infrastructure. | ||
|
|
||
| ## Overview | ||
|
|
||
| Manage your network interfaces, subnets, and routing tables. | ||
|
|
||
| ## Configuration | ||
|
|
||
| You can configure: | ||
| - **Interfaces**: Manage physical and virtual network interfaces. | ||
| - **DNS**: Configure DNS settings. | ||
| - **Firewall**: Manage firewall rules. |
| Original file line number | Diff line number | Diff line change | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,23 @@ | ||||||||||
| --- | ||||||||||
| title: Get Started | ||||||||||
| description: Get started with OtterScale. | ||||||||||
| --- | ||||||||||
|
|
||||||||||
| Welcome to OtterScale! This guide will help you get up and running with the platform. | ||||||||||
|
|
||||||||||
| ## Introduction | ||||||||||
|
|
||||||||||
| OtterScale is a powerful platform for managing your infrastructure and applications. | ||||||||||
|
|
||||||||||
| ## Prerequisites | ||||||||||
|
|
||||||||||
| Before you begin, ensure you have the following: | ||||||||||
| - An account on OtterScale. | ||||||||||
| - Access to the necessary resources. | ||||||||||
|
|
||||||||||
| ## Next Steps | ||||||||||
|
|
||||||||||
| Once you are set up, you can proceed to: | ||||||||||
| - [Manage Scopes](/scope) | ||||||||||
| - [Explore Basic Features](/basic/machines) | ||||||||||
| - [Deploy Applications](/application/applications) | ||||||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The link to 'Deploy Applications' appears to be broken. Based on the project's file structure and sidebar configuration, the correct path should be
Suggested change
|
||||||||||
| - [Deploy Applications](/application/applications) | |
| - [Deploy Applications](/service/applications) |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| --- | ||
| title: Scope | ||
| description: Manage scopes in OtterScale. | ||
| --- | ||
|
|
||
| Scopes allow you to organize your resources and control access. | ||
|
|
||
| ## Selecting a Scope | ||
|
|
||
| You can select a scope from the dropdown menu in the navigation bar. This will filter the resources you see to only those within the selected scope. | ||
|
|
||
| ## Creating a Scope | ||
|
|
||
| To create a new scope: | ||
| 1. Navigate to the Scope management area. | ||
| 2. Click on "Create Scope". | ||
| 3. Enter the necessary details. | ||
| 4. Confirm the creation. | ||
|
|
||
| ## Managing Scopes | ||
|
|
||
| You can manage existing scopes, including updating settings and managing access. |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| --- | ||
| title: Applications | ||
| description: Manage applications, workloads, and services. | ||
| --- | ||
|
|
||
| The Applications section is the hub for managing your workloads and services. | ||
|
|
||
| ## Workloads | ||
|
|
||
| Manage your containerized workloads. You can deploy, scale, and monitor your applications here. | ||
|
|
||
| ## Services | ||
|
|
||
| Configure services to expose your workloads to the network. | ||
|
|
||
| ## Secrets | ||
|
|
||
| Manage sensitive information such as API keys and passwords securely. | ||
|
|
||
| ## Store | ||
|
|
||
| Browse and deploy applications from the application store. |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| --- | ||
| title: Compute (VM) | ||
| description: Manage Virtual Machines. | ||
| --- | ||
|
|
||
| The Compute section allows you to create and manage Virtual Machines (VMs). | ||
|
|
||
| ## Creating a VM | ||
|
|
||
| To create a new VM: | ||
| 1. Go to the Compute section. | ||
| 2. Click "Create VM". | ||
| 3. Select the OS image, CPU, and RAM configuration. | ||
| 4. Configure networking and storage. | ||
| 5. Launch the VM. | ||
|
|
||
| ## Managing VMs | ||
|
|
||
| You can start, stop, restart, and delete VMs from this interface. |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| --- | ||
| title: Models (LLM) | ||
| description: Manage LLM models in OtterScale. | ||
| --- | ||
|
|
||
| The Models section allows you to manage Large Language Models (LLMs) deployed on your infrastructure. | ||
|
|
||
| ## Overview | ||
|
|
||
| View available models, their status, and resource consumption. | ||
|
|
||
| ## Deploying a Model | ||
|
|
||
| To deploy a new model: | ||
| 1. Navigate to the Models section. | ||
| 2. Select "Deploy Model". | ||
| 3. Choose the model type and configuration. | ||
| 4. Confirm deployment. |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| --- | ||
| title: Settings | ||
| description: Application-specific settings. | ||
| --- | ||
|
|
||
| The Settings section allows you to configure settings specific to your application scope. | ||
|
|
||
| ## General Settings | ||
|
|
||
| Configure general preferences for the current scope. | ||
|
|
||
| ## Access Control | ||
|
|
||
| Manage access policies and permissions for this scope. |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| --- | ||
| title: Storage | ||
| description: Manage storage resources. | ||
| --- | ||
|
|
||
| The Storage section provides comprehensive management for various storage types. | ||
|
|
||
| ## OSD (Object Storage Daemon) | ||
|
|
||
| Manage the underlying storage daemons. | ||
|
|
||
| ## Pools | ||
|
|
||
| Create and manage storage pools for better resource allocation. | ||
|
|
||
| ## Block Devices | ||
|
|
||
| Manage block devices for your VMs and applications. | ||
|
|
||
| ## File Systems | ||
|
|
||
| Configure and manage file systems. | ||
|
|
||
| ## SMB | ||
|
|
||
| Setup and manage SMB shares. | ||
|
|
||
| ## Object Storage | ||
|
|
||
| Manage object storage buckets and access. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The sidebar uses Chinese labels ('基礎' and '服務') while the rest of the configuration uses English labels ('Get Started', 'Scope'). This creates inconsistency in the navigation. Consider using English labels ('Basic' and 'Service') to maintain consistency, or provide localized sidebars if multi-language support is intended.