Skip to content

docs: [#214] update user documentation for provider selection#215

Merged
josecelano merged 1 commit intomainfrom
214-update-user-documentation-for-provider-selection
Dec 3, 2025
Merged

docs: [#214] update user documentation for provider selection#215
josecelano merged 1 commit intomainfrom
214-update-user-documentation-for-provider-selection

Conversation

@josecelano
Copy link
Copy Markdown
Member

Summary

This PR updates the user documentation to ensure provider selection is well-documented throughout the user-facing documentation, as part of the Hetzner Provider Support epic (#205).

Changes

README.md Fixes

  • Fixed broken emoji in roadmap section (🗺️)
  • Fixed incorrect E2E test command names (e2e-provision-testse2e-provision-and-destroy-tests)
  • Updated development status to reflect Hetzner Cloud support as implemented
  • Added providers/ directory reference to repository structure
  • Updated Next Steps section to reflect that Hetzner implementation is complete

Provider Documentation Integration

  • quick-start.md: Added "Choose Your Provider" section before the workflow steps with LXD and Hetzner examples
  • commands.md: Added "Provider Configuration" section explaining that all environments require a provider section
  • commands/provision.md: Added provider-specific prerequisites and output sections explaining different resources created per provider

Testing

All pre-commit checks pass:

  • ✅ 1250 unit tests
  • ✅ 4 E2E create tests
  • ✅ 4 E2E destroy tests
  • ✅ Documentation builds successfully
  • ✅ All linting checks pass (markdown, yaml, toml, clippy, rustfmt, shellcheck, cspell)

Related Issues

Checklist

  • I have followed the project conventions in AGENTS.md
  • Pre-commit checks pass (./scripts/pre-commit.sh)
  • Documentation is clear and follows project style

- Fix broken emoji in README.md roadmap section (🗺️)
- Fix incorrect E2E test command names (e2e-provision-and-destroy-tests)
- Update README.md development status to reflect Hetzner Cloud support
- Add providers/ directory reference to repository structure
- Update README.md Next Steps to reflect Hetzner implementation
- Add provider selection section to quick-start.md
- Add provider configuration section to commands.md
- Add provider-specific prerequisites and output to provision.md
@josecelano
Copy link
Copy Markdown
Member Author

ACK b62138e

@josecelano josecelano merged commit 8dc255a into main Dec 3, 2025
35 of 38 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update user documentation for provider selection

1 participant