Skip to content

docs(ddg): replace inline HTML in header and Variables tables with Markdown - #398

Merged
aghassemlouei merged 3 commits into
google:mainfrom
pulsingSignal:docs/ddg-remove-inline-html
Nov 12, 2026
Merged

aghassemlouei merged 3 commits into
google:mainfrom
pulsingSignal:docs/ddg-remove-inline-html

Conversation

@pulsingSignal

Copy link
Copy Markdown
Collaborator

Description

Google Drive and Google Docs now open .md files natively in Markdown mode, where inline HTML formatting (<strong>, <a href='...'>, <br/>) is displayed as raw text instead of rendered formatting. Because operators copy docs/ddg.md into Google Docs to fill out the Variables table, those inline HTML tags appear literally in the table cells.

This change replaces the inline HTML in the docs/ddg.md header table (lines 5–9) and Variables table (lines 66–78) with standard Markdown:

  • Replaces all 23 <strong>...</strong> tags with **...**
  • Replaces the two <a href='...'>...</a> links (Console Link and compliance regime) with Markdown links [...](...)
  • Replaces <br/> in the Customer ID description with a space, matching the adjacent gcloud organizations list rows

Fixes #397

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
    • DoD IL4
    • DoD IL5
    • General / All
  • NIST 800-53r5 Controls: None (formatting-only documentation 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/stages-aw/ can be leveraged for this change.
  • My code follows the established naming conventions outlined in docs/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, IL4, IL5, etc.).

Testing

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

Testing Performed

  • Verified no inline <strong>, <a>, or <br> HTML tags remain in docs/ddg.md (! grep -nE '</?(strong|a|br)\b' docs/ddg.md)
  • Verified Markdown link validity with uv run --locked python tools/check_links.py docs (all 28 links in docs/ddg.md pass)
  • Ran repository and CLI documentation sync tests (uv run pytest in cli/tests/test_repo.py)

@google-cla

google-cla Bot commented Nov 5, 2026

Copy link
Copy Markdown

Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

View this failed invocation of the CLA check for more information.

For the most up to date status, view the checks section at the bottom of the pull request.

@github-actions github-actions Bot added 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 - Low Minor polish, typo fixes, or technical debt; nice to have; pick up when time permits labels Nov 5, 2026

@aghassemlouei aghassemlouei left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Verified docs/ddg.md with tools/check_links.py, GFM AST parsing, and cli/tests/test_repo.py. All 23 <strong> replacements, both Markdown link conversions, and the Customer ID <br/> cleanup render cleanly with all six CI checks passing.

Before merging, cla/google is failing on b20011f3 because 352168058+pulsingSignal@users.noreply.github.com is not matched to an active CLA record at cla.developers.google.com. Amending the commit author email to a CLA-covered address attached to @pulsingSignal, or adding this noreply address to the CLA group and running a rescan, will clear the check.

Comment thread docs/ddg.md Resolved
@pulsingSignal
pulsingSignal force-pushed the docs/ddg-remove-inline-html branch from be43474 to 4caf0e1 Compare November 5, 2026 18:27

@aghassemlouei aghassemlouei left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Confirmed the line 44 backtick and filename fix in 4caf0e1, main merge in a9cd61c, and passing checks across docs/ddg.md.

@aghassemlouei
aghassemlouei merged commit 7180ce8 into google:main Nov 12, 2026
16 checks passed
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 - Low Minor polish, typo fixes, or technical debt; nice to have; pick up when time permits

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Documentation] docs/ddg.md: the header and Variables tables use inline HTML, which Google Docs now shows as raw text

2 participants