Repository navigation
docs: align validation scope, supported systems and wording - #31
Merged
Merged
Conversation
- Replace Production Ready with scoped production status and validation scope - Restrict supported systems to Debian 12 and Ubuntu 22.04 - Map to NIST 800-53 and CIS instead of claiming compliance - Describe Tailscale as a private mesh; cite NIST SP 800-207 by its official title - Document SOPS + age as the secrets mechanism - Reorder README closing sections and fix contact role - Updated GLOSSARY.md to clarify terminology and definitions, including changes to Zero Trust and Private Mesh. - Revised README.md to specify the framework's alignment with NIST 800-53 for Debian 12 and Ubuntu 22.04. - Modified ARCHITECTURE.md to reflect the updated compliance mapping and architectural details, including the removal of references to unsupported OS versions. - Adjusted LAYER_BOUNDARIES.md to align with the current OS support and architecture. - Enhanced ADR-05.md with an amendment regarding the scope of supported OS versions. - Updated COMPLIANCE-MAPPING-STATUS.md to clarify the status of various compliance frameworks and their implementation. - Revised INDEX.md to reflect the updated terminology regarding NIST SP 800-207. - Adjusted NIST_800_53.md to clarify compliance status and related documents. - Updated PRODUCTION_ACCEPTANCE.md to specify validation criteria for production readiness. - Revised FINOPS-BASELINE.md to clarify metrics and impacts of the transition to self-hosted solutions. - Adjusted BACKUP_STRATEGY.md to clarify the scope of the backup engine. - Updated COMPATIBILITY_MATRIX.md to reflect the current state of OS support and testing. - Revised DEVELOPER_SETUP.md to clarify common issues and resolutions. - Updated ROADMAP.md to reflect changes in planned releases and future implementations. - Adjusted DEVELOPER_WORKSTATION_GUIDE.md to reflect the shift from Zero Trust to Private Mesh model. - Revised HARDENING-STATUS.md to clarify the security baseline for developer and operator workstations.
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.
This pull request updates the project branding and documentation to reflect the new "Developmi Hardened" name, clarifies the scope and validation status, and improves the structure and accuracy of the README and supporting files. The changes focus on aligning terminology, updating compliance language, and providing a clearer, more detailed overview of the project's capabilities and validation evidence.
Branding and Naming Updates:
.ansible-lint,.yamllint,CONTRIBUTING.md, andREADME.md. [1] [2] [3] [4]Documentation Structure and Clarity:
README.mdto use clearer section headings, a more detailed table of contents, and improved descriptions of features, value proposition, validation scope, compliance mapping, and operational instructions. [1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11] [12] [13] [14]Compliance and Validation Language:
Role and Maintainer Updates:
Changelog and Contributor Docs:
These changes collectively improve project clarity, transparency, and professional presentation for contributors and users.