|
1 | | -# Holodeck |
| 1 | +# Holodeck 9.0 Documentation |
| 2 | + |
| 3 | +[](https://github.com/vmware/Holodeck/actions/workflows/ci.yml) |
| 4 | +[](https://github.com/vmware/Holodeck/actions/workflows/links.yml) |
| 5 | +[](https://vmware.github.io/Holodeck/) |
| 6 | + |
| 7 | +This repository contains the source for the [Holodeck documentation site](https://vmware.github.io/Holodeck/), built with [MkDocs Material](https://squidfunk.github.io/mkdocs-material/). |
| 8 | + |
| 9 | +Holodeck is a toolkit for deploying nested VMware Cloud Foundation (VCF) environments on a single ESX host or vSphere cluster. It automates the provisioning of fully self-contained VCF labs for testing, training, and capability exploration. |
| 10 | + |
| 11 | +## Documentation Overview |
| 12 | + |
| 13 | +The site covers the following topics: |
| 14 | + |
| 15 | +- **Getting Started** -- Prerequisites, deployment steps, and post-deployment access |
| 16 | +- **Release Notes** -- Features, enhancements, bug fixes, and known issues per release |
| 17 | +- **Downloads** -- Links to HoloRouter OVA, VCF binaries, and the Offline Depot appliance |
| 18 | +- **Command Reference** -- PowerShell cmdlets for managing Holodeck instances |
| 19 | +- **Offline Depot** -- Deploying and configuring the Offline Depot Appliance for air-gapped environments |
| 20 | +- **Support** -- How to report issues, request features, and join the community |
| 21 | +- **FAQ** -- Troubleshooting and frequently asked questions |
| 22 | + |
| 23 | +## Local Development |
| 24 | + |
| 25 | +To build and preview the documentation locally: |
| 26 | + |
| 27 | +### Prerequisites |
| 28 | + |
| 29 | +- Python 3.12 or later |
| 30 | +- Git |
| 31 | + |
| 32 | +### Setup |
| 33 | + |
| 34 | +```bash |
| 35 | +git clone https://github.com/vmware/Holodeck.git |
| 36 | +cd Holodeck |
| 37 | +python -m venv venv |
| 38 | +source venv/bin/activate |
| 39 | +pip install -r requirements.txt |
| 40 | +``` |
| 41 | + |
| 42 | +### Preview |
| 43 | + |
| 44 | +```bash |
| 45 | +mkdocs serve |
| 46 | +``` |
| 47 | + |
| 48 | +The site will be available at `http://127.0.0.1:8000`. Changes to Markdown files are reflected automatically. |
| 49 | + |
| 50 | +## Contributing |
| 51 | + |
| 52 | +1. Fork the repository and create a feature branch. |
| 53 | +2. Make your changes in the `docs/` directory. |
| 54 | +3. Preview locally with `mkdocs serve` to verify formatting. |
| 55 | +4. Submit a pull request against the `main` branch. |
| 56 | + |
| 57 | +For bug reports and feature requests related to Holodeck itself, please use [GitHub Issues](https://github.com/vmware/Holodeck/issues). |
| 58 | + |
| 59 | +## Disclaimer |
| 60 | + |
| 61 | +Holodeck is not an officially supported product. It is intended for testing and training environments only. |
0 commit comments