fix: add README.md and remove legacy AsciiDoc files#21
Merged
kristopherjturner merged 3 commits intomainfrom Mar 24, 2026
Merged
fix: add README.md and remove legacy AsciiDoc files#21kristopherjturner merged 3 commits intomainfrom
kristopherjturner merged 3 commits intomainfrom
Conversation
- Add README.md to satisfy validate-repo-structure workflow - Remove README.adoc (replaced by README.md) - Remove docs/_archived_adoc/ (legacy AsciiDoc content migrated to MkDocs)
There was a problem hiding this comment.
Pull request overview
Adds the required root README.md to satisfy the Validate Repo Structure workflow and removes legacy AsciiDoc documentation artifacts that were already migrated to MkDocs.
Changes:
- Added a root
README.mdrequired by.github/workflows/validate-repo-structure.yml. - Removed the legacy root
README.adocin favor of Markdown. - Deleted the
docs/_archived_adoc/tree (legacy AsciiDoc docs, theme, and hub files).
Reviewed changes
Copilot reviewed 31 out of 31 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
README.md |
Adds a root README to satisfy repo-structure validation and provide a quick start. |
README.adoc |
Removes legacy AsciiDoc README replaced by README.md. |
docs/_archived_adoc/index.adoc |
Removes legacy AsciiDoc documentation hub (pre-MkDocs). |
docs/_archived_adoc/main.adoc |
Removes legacy AsciiDoc “book” builder file (pre-MkDocs). |
docs/_archived_adoc/themes/azurelocal-theme.yml |
Removes legacy asciidoctor-pdf theme from archived docs area. |
docs/_archived_adoc/getting-started/introduction.adoc |
Removes archived AsciiDoc getting-started intro. |
docs/_archived_adoc/getting-started/architecture.adoc |
Removes archived AsciiDoc architecture doc. |
docs/_archived_adoc/getting-started/prerequisites.adoc |
Removes archived AsciiDoc prerequisites doc. |
docs/_archived_adoc/getting-started/installation.adoc |
Removes archived AsciiDoc installation doc. |
docs/_archived_adoc/getting-started/configuration.adoc |
Removes archived AsciiDoc configuration doc. |
docs/_archived_adoc/tools/vmfleet/overview.adoc |
Removes archived VMFleet overview (migrated to MkDocs). |
docs/_archived_adoc/tools/vmfleet/prerequisites.adoc |
Removes archived VMFleet prerequisites doc. |
docs/_archived_adoc/tools/vmfleet/deployment.adoc |
Removes archived VMFleet deployment doc. |
docs/_archived_adoc/tools/vmfleet/workload-profiles.adoc |
Removes archived VMFleet workload profiles doc. |
docs/_archived_adoc/tools/vmfleet/monitoring.adoc |
Removes archived VMFleet monitoring doc. |
docs/_archived_adoc/tools/vmfleet/reporting.adoc |
Removes archived VMFleet reporting doc. |
docs/_archived_adoc/tools/vmfleet/troubleshooting.adoc |
Removes archived VMFleet troubleshooting doc. |
docs/_archived_adoc/tools/fio/overview.adoc |
Removes archived fio overview doc. |
docs/_archived_adoc/tools/iperf/overview.adoc |
Removes archived iPerf overview doc. |
docs/_archived_adoc/tools/hammerdb/overview.adoc |
Removes archived HammerDB overview doc. |
docs/_archived_adoc/tools/stress-ng/overview.adoc |
Removes archived stress-ng overview doc. |
docs/_archived_adoc/operations/ci-cd.adoc |
Removes archived CI/CD operations doc. |
docs/_archived_adoc/operations/credential-management.adoc |
Removes archived credential management doc. |
docs/_archived_adoc/reference/variable-reference.adoc |
Removes archived variable reference doc. |
docs/_archived_adoc/reference/cmdlet-reference.adoc |
Removes archived cmdlet reference doc. |
docs/_archived_adoc/reference/glossary.adoc |
Removes archived glossary doc. |
docs/_archived_adoc/standards/documentation-standards.adoc |
Removes archived documentation standards doc. |
docs/_archived_adoc/standards/scripting-standards.adoc |
Removes archived scripting standards doc. |
docs/_archived_adoc/standards/variables-environment-standards.adoc |
Removes archived variables/environment standards doc. |
docs/_archived_adoc/standards/badge-standards.adoc |
Removes archived badge standards doc. |
docs/_archived_adoc/standards/asciidoc-reference.adoc |
Removes archived AsciiDoc reference doc. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+12
to
+25
| azurelocal-loadtools/ | ||
| ├── config/ # Central variable reference (variables.example.yml) | ||
| ├── src/ # Shared modules and helpers | ||
| ├── tools/ # One folder per test tool | ||
| │ ├── vmfleet/ # Storage IOPS / throughput / latency (DiskSpd) | ||
| │ ├── fio/ # Fine-grained storage I/O benchmarking | ||
| │ ├── iperf/ # Network bandwidth, jitter, packet loss | ||
| │ ├── hammerdb/ # SQL Server OLTP / OLAP benchmarking | ||
| │ └── stress-ng/ # CPU, memory, and system stress testing | ||
| ├── docs/ # Documentation (MkDocs source) | ||
| ├── tests/ # Validation scripts | ||
| ├── monitoring/ # Monitoring dashboards and alerting | ||
| ├── reports/ # Generated test reports | ||
| └── .github/workflows/ # GitHub Actions workflows |
There was a problem hiding this comment.
The repository structure tree lists src/, monitoring/, and reports/ at the repo root, but those directories don't exist in this repo (root currently has common/, tools/, docs/, logs/, state/, etc.). Please update the tree to match the actual checked-in layout (or clarify which paths are generated at runtime).
Comment on lines
+41
to
+44
| -ConfigPath "config\variables.yml" ` | ||
| -Profiles @("General") ` | ||
| -CredentialSource Interactive ` | ||
| -GenerateReports |
There was a problem hiding this comment.
The Quick Start command uses parameters -ConfigPath, -Profiles, -CredentialSource, and -GenerateReports, but tools/vmfleet/Invoke-VMFleetPipeline.ps1 currently defines SolutionConfigPath, ClusterConfigPath, ProfilePath, Credential, and ReportFormats instead. As written, the README example won't run; please align the README with the current script interface (or update the script to match the documented interface).
Suggested change
| -ConfigPath "config\variables.yml" ` | |
| -Profiles @("General") ` | |
| -CredentialSource Interactive ` | |
| -GenerateReports | |
| -SolutionConfigPath "config\solution.yml" ` | |
| -ClusterConfigPath "config\variables.yml" ` | |
| -ProfilePath "tools\vmfleet\profiles\General.yml" ` | |
| -Credential (Get-Credential) ` | |
| -ReportFormats @("Html") |
The mkdocs-drawio plugin matches image alt text to drawio page names. Alt text was 'Five-Layer Architecture' but the page is named 'Solution Architecture', causing a warning that aborts the build in --strict mode.
The validate-repo-structure workflow checks for .github/PULL_REQUEST_TEMPLATE.md but git tracked the file as lowercase pull_request_template.md. GitHub Actions runs on Linux (case-sensitive), so the check failed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fixes the failing Validate Repo Structure workflow check by adding the required
README.mdand cleaning up legacy AsciiDoc artifacts from the pre-MkDocs migration.Changes
README.md— required byvalidate-repo-structure.yml(line 15). Content based ondocs/index.mdand sibling repo format.README.adoc— replaced byREADME.md.docs/_archived_adoc/— 30 legacy AsciiDoc files already migrated to MkDocs.Validation
All 11 checks in the workflow should now pass: