docs: clean up documentation for open-source release#66
Merged
Conversation
**Added:** - Added `CONTRIBUTING.md` with contribution guidelines, code style, testing, and issue reporting instructions - New provider guide for deploying on VMware Workstation from Windows hosts (`docs/mkdocs/docs/providers/vmware_windows.md`), including networking and Ansible setup **Changed:** - Refactored `README.md` to emphasize DreadGOAD-specific features, project differences from upstream GOAD, lab variants, quick start, and project structure; streamlined usage and installation instructions - Updated `docs/domains-and-users.md` to simplify host/IP/domain tables and clarify that domain admin passwords are set at provisioning time - Revised `docs/mkdocs/docs/index.md` to introduce DreadGOAD, highlight differences from upstream GOAD, and clarify vulnerability and safety warnings; added project acknowledgments - Updated provisioning documentation (`docs/mkdocs/docs/provisioning.md`) to include Docker-based Ansible provisioning, explicit Vagrant management commands, disable/re-enable vagrant user instructions, and clearer playbook sequencing - Updated `docs/validation.md` for improved instance ID redaction, troubleshooting, and script usage notes - Updated `docs/mkdocs/mkdocs.yml`: - Changed site metadata to DreadGOAD and updated repo URLs - Added navigation for new VMware on Windows provider guide - Updated social links to point to DreadGOAD repo **Removed:** - Removed outdated documentation in `docs/olddocs/` and legacy provider install guides to reduce confusion and avoid duplication with new documentation - Deleted `docs/FQDNs.md` and legacy architecture diagrams no longer referenced
dreadnode-renovate-bot
Bot
added
area/readme
l50
changed the title
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
1 participant
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.
Key Changes:
Added:
CONTRIBUTING.mdwith detailed guidelines for contributing code, labs, roles, and documentationdocs/mkdocs/docs/providers/vmware_windows.mdcovering VMware Workstation setup on Windows hostsChanged:
README.mdrewritten for brevity, clarity, and new project scope; added quick start, variant generator, and contributor acknowledgmentsdocs/mkdocs/docs/index.md,docs/mkdocs/docs/provisioning.md, and provider docs for consistency and current best practicesdocs/domains-and-users.mdsimplified to focus on key host/domain rolesdocs/mkdocs/mkdocs.yml) updated with new site metadata, navigation, and social linksdocs/validation.md) updated with clearer troubleshooting and AWS validation instructionsRemoved:
docs/olddocs/including legacy install, troubleshooting, and provisioning instructions now superseded by current docsaws.drawio,diagram.drawio) replaced by new SVGs indocs/docs/FQDNs.md) and redundant info