Skip to content

Documentation outdated: docs/how-to/separate-home-disk.md - "Premium SSD coming soon" note is stale #950

@github-actions

Description

@github-actions

Problem

docs/how-to/separate-home-disk.md line 205 contains a stale "coming soon" notice:

Note: azlin currently defaults to Standard HDD. Premium SSD support coming soon.

Why This Is Stale

The feature has already been implemented in the Rust rewrite (v2.3.0+). The azlin disk add command fully supports disk SKU selection via the --sku flag:

# Add a Premium SSD disk
azlin disk add (vm) --size 100 --sku Premium_LRS

# Add a Standard SSD disk
azlin disk add (vm) --size 100 --sku StandardSSD_LRS

# Default (Standard HDD)
azlin disk add (vm) --size 100 --sku Standard_LRS

The implementation in rust/crates/azlin-cli/src/lib.rs defines:

/// Disk SKU (Standard_LRS, Premium_LRS, etc.)
#[arg(long, default_value = "Standard_LRS")]
sku: String,

Tests in parity_tests.rs confirm both Standard_LRS and Premium_LRS work.

Suggested Fix

Replace the stale note on line 205 with accurate documentation:

> **Note**: azlin defaults to Standard HDD (`Standard_LRS`). Use `--sku Premium_LRS` 
> for Premium SSD, or `--sku StandardSSD_LRS` for Standard SSD. See [disk add command](#) 
> for all supported SKU types.

Also consider adding a "Disk SKU Options" section documenting the supported values:

  • Standard_LRS - Standard HDD (default, lowest cost)
  • StandardSSD_LRS - Standard SSD (balanced)
  • Premium_LRS - Premium SSD (high performance)
  • UltraSSD_LRS - Ultra Disk (if supported in region)

Impact

Users reading this guide will think Premium SSD is not yet available and may avoid using the feature or work around it unnecessarily.

Generated by Documentation Freshness Checker

Metadata

Metadata

Assignees

No one assigned

    Labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions