Skip to content

docs: fix DDG stage drift, prefix limit, and README formatting - #266

Merged
aghassemlouei merged 1 commit into
mainfrom
docs/scripts-readme-cleanup
Sep 25, 2026
Merged

aghassemlouei merged 1 commit into
mainfrom
docs/scripts-readme-cleanup

Conversation

@aghassemlouei

@aghassemlouei aghassemlouei commented Sep 25, 2026 •

Copy link
Copy Markdown
Member

Description

Addresses documentation formatting and deployment guide drift across scripts/README.md, README.md, docs/prerequisites.md, docs/ddg.md, and docs/naming-convention.md:

Fixes #258

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update

Deployment & Compliance Impact

  • Applicable Regimes:
    • US Region Restricted (e.g., Access Policy constraint)
    • FedRAMP Moderate
    • FedRAMP High
    • FedRAMP Moderate
    • DoD IL4
    • DoD IL5
    • General / All
  • NIST 800-53r5 Controls: N/A (documentation accuracy and formatting update)

Checklist

Code Quality & Reusability

  • My code adheres to the Maximize Reusability principle. I have not redefined common elements and have reused existing base configurations and modules where possible.
  • I have checked that no existing module or configuration in modules/ or fast/ can be leveraged for this change.
  • My code follows the established naming conventions outlined in documentation/naming-convention.md.

Documentation

  • I have updated the README.md of the modified module or blueprint.
  • I have added/updated documentation for inputs (variables) and outputs.

Security

  • My change adheres to GCP security best practices and the principle of least privilege.
  • I have ensured compliance with the targeted regime (FedRAMP Moderate, FedRAMP High, IL5, etc.).

Testing

  • I have tested my changes locally.
  • I have included details of my testing in this PR.

Testing Performed

Verified markdown structure across scripts/README.md, README.md, docs/prerequisites.md, docs/ddg.md, and docs/naming-convention.md, and ran bash tests/scripts/run_shell_tests.sh and pytest locally.

@aghassemlouei aghassemlouei added Documentation Improvements or additions to documentation Priority - Low Minor polish, typo fixes, or technical debt; nice to have; pick up when time permits Level of Effort - Low Quick, well-defined tasks with no unknowns; takes a few hours up to one day to complete Scope - Fast Related to Fabric FAST deployment stages in the fast directory labels Sep 25, 2026
@aghassemlouei
aghassemlouei marked this pull request as ready for review September 25, 2026 19:55
@aghassemlouei
aghassemlouei enabled auto-merge (squash) September 25, 2026 19:55

@Calvin-Cheng1 Calvin-Cheng1 left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@aghassemlouei
aghassemlouei merged commit 039f13a into main Sep 25, 2026
20 checks passed
@aghassemlouei
aghassemlouei deleted the docs/scripts-readme-cleanup branch September 25, 2026 20:13
@aghassemlouei aghassemlouei changed the title docs(scripts): clean up headings and bullet formatting in READMEs docs: fix DDG stage drift, prefix limit, and README formatting Sep 25, 2026
@aghassemlouei aghassemlouei added Priority - Medium Standard features and non-blocking bugs; important for the current milestone but not urgent and removed Priority - Low Minor polish, typo fixes, or technical debt; nice to have; pick up when time permits labels Sep 25, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Documentation Improvements or additions to documentation Level of Effort - Low Quick, well-defined tasks with no unknowns; takes a few hours up to one day to complete Priority - Medium Standard features and non-blocking bugs; important for the current milestone but not urgent Scope - Fast Related to Fabric FAST deployment stages in the fast directory

Projects

None yet

4 participants