Repository navigation
docs(ddg): replace inline HTML in header and Variables tables with Markdown - #398
pulsingSignal wants to merge 2 commits into
Conversation
|
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. |
aghassemlouei
left a comment
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
On line 44, the unmatched double backtick causes CommonMark and Google Docs Markdown mode to parse <stage-name> as the sole remaining raw InlineHTML tag in docs/ddg.md while GitHub strips <stage-name> from the rendered page, and Stages 0 through 3 write <stage-name>.auto.tfvars.json without -tfvar:
-completion of a stage, the Terraform code will write out a **``<stage-name>`-tfvar.auto.tfvars.json`** file to the Google Cloud Storage
+completion of a stage, the Terraform code will write out a **`<stage-name>.auto.tfvars.json`** file to the Google Cloud Storagebe43474 to
4caf0e1
Compare
Description
Google Drive and Google Docs now open
.mdfiles natively in Markdown mode, where inline HTML formatting (<strong>,<a href='...'>,<br/>) is displayed as raw text instead of rendered formatting. Because operators copydocs/ddg.mdinto 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.mdheader table (lines 5–9) and Variables table (lines 66–78) with standard Markdown:<strong>...</strong>tags with**...**<a href='...'>...</a>links (Console Linkandcompliance regime) with Markdown links[...](...)<br/>in the Customer ID description with a space, matching the adjacentgcloud organizations listrowsFixes #397
Type of Change
Deployment & Compliance Impact
Checklist
Code Quality & Reusability
modules/orfast/stages-aw/can be leveraged for this change.docs/naming-convention.md.Documentation
README.mdof the modified module or blueprint.Security
Testing
Testing Performed
<strong>,<a>, or<br>HTML tags remain indocs/ddg.md(! grep -nE '</?(strong|a|br)\b' docs/ddg.md)uv run --locked python tools/check_links.py docs(all 28 links indocs/ddg.mdpass)uv run pytestincli/tests/test_repo.py)